Example GitBook website using GitLab Pages.
Table of Contents generated with DocToc
# requiring the environment of NodeJS 10 image: node:10 # add 'node_modules' to cache for speeding up builds cache: paths: - node_modules/ # Node modules and dependencies before_script: - npm install gitbook-cli -g # install gitbook - gitbook fetch 3.2.3 # fetch final stable version - gitbook install # add any requested plugins in book.json test: stage: test script: - gitbook build . public # build to public path only: - branches # this job will affect every branch except 'master' except: - master # the 'pages' job will deploy and build your site to the 'public' path pages: stage: deploy script: - gitbook build . public # build to public path artifacts: paths: - public expire_in: 1 week only: - master # this job will affect only the 'master' branch
To work locally with this project, you'll have to follow the steps below:
- Fork, clone or download this project
- Install GitBook
npm install gitbook-cli -g
- Fetch GitBook's latest stable version
gitbook fetch latest
- Preview your project:
- Add content
- Generate the website:
- Push your changes to the master branch:
Read more at GitBook's documentation.
GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to
groupname. This can be done by navigating to your
Did you fork this project?
If you forked this project for your own use, please go to your project's Settings and remove the forking relationship, which won't be necessary unless you want to contribute back to the upstream project.
CSS is missing! That means two things:
Either that you have wrongly set up the CSS URL in your templates, or your static generator has a configuration option that needs to be explicitly set in order to serve static assets under a relative URL.
Forked from @virtuacreative