1
0
mirror of synced 2024-12-22 20:50: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

@ -21,4 +21,4 @@ pages:
paths: paths:
- public - public
only: 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. 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 Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/. documentation https://docs.gitlab.com/ce/user/project/pages/.
@ -57,7 +50,7 @@ pages:
paths: paths:
- public - public
only: only:
- pages # this job will affect only the 'pages' branch - master # this job will affect only the 'master' branch
``` ```
## Building locally ## Building locally
@ -65,7 +58,6 @@ pages:
To work locally with this project, you'll have to follow the steps below: To work locally with this project, you'll have to follow the steps below:
1. Fork, clone or download this project 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. [Install][] GitBook `npm install gitbook-cli -g`
1. Fetch GitBook's latest stable version `gitbook fetch latest` 1. Fetch GitBook's latest stable version `gitbook fetch latest`
1. Preview your project: `gitbook serve` 1. Preview your project: `gitbook serve`

4
SUMMARY.md Normal file
View File

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