1
0
mirror of synced 2024-12-22 12:40:00 +01:00

Update GitBook info

This commit is contained in:
Achilleas Pipinellis 2017-04-03 13:33:48 +02:00
parent 9eaa4e4ea9
commit 2d071ea9b7
4 changed files with 12 additions and 15 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
_book/

View File

@ -3,7 +3,7 @@ image: node:4.2.2
# add 'node_modules' to cache for speeding up builds
cache:
paths:
paths:
- node_modules/ # Node modules and dependencies
before_script:
@ -19,6 +19,6 @@ pages:
- gitbook build . public # build to public path
artifacts:
paths:
- public
- public
only:
- pages # this job will affect only the 'pages' branch
- master # this job will affect only the 'master' branch

View File

@ -4,13 +4,6 @@
Example [GitBook] website using GitLab Pages.
This project uses an orphan branch (`pages`) to [host the book][], since GitBook
[expects a README.md](http://toolchain.gitbook.com/structure.html) file present
in the root directory, and we already use one in the `master` branch to provide
information about GitBook on GitLab Pages. That way, you can have your project's
code in the `master` branch and use `pages` for accommodating only your website
content.
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
@ -39,7 +32,7 @@ image: node:4.2.2
# add 'node_modules' to cache for speeding up builds
cache:
paths:
paths:
- node_modules/ # Node modules and dependencies
before_script:
@ -55,9 +48,9 @@ pages:
- gitbook build # build to public path
artifacts:
paths:
- public
- public
only:
- pages # this job will affect only the 'pages' branch
- master # this job will affect only the 'master' branch
```
## Building locally
@ -65,7 +58,6 @@ pages:
To work locally with this project, you'll have to follow the steps below:
1. Fork, clone or download this project
1. Track `pages` branch: `git checkout --track origin/pages`
1. [Install][] GitBook `npm install gitbook-cli -g`
1. Fetch GitBook's latest stable version `gitbook fetch latest`
1. Preview your project: `gitbook serve`
@ -108,4 +100,4 @@ Forked from @virtuacreative
[install]: http://toolchain.gitbook.com/setup.html
[documentation]: http://toolchain.gitbook.com
[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages
[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages

4
SUMMARY.md Normal file
View File

@ -0,0 +1,4 @@
# Summary
* [Introduction](README.md)