From 7a91657af12424c79b4e858f5422b8721be94464 Mon Sep 17 00:00:00 2001 From: GitLab Date: Wed, 6 Mar 2019 09:53:07 +0100 Subject: [PATCH] Initial template creation --- .gitignore | 5 +++ .gitlab-ci.yml | 33 ++++++++++++++++ README.md | 104 +++++++++++++++++++++++++++++++++++++++++++++++++ SUMMARY.md | 4 ++ 4 files changed, 146 insertions(+) create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 README.md create mode 100644 SUMMARY.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f815093 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/_book/ +/node_modules/ +/book.pdf +/book.mobi +/book.epub \ No newline at end of file diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..8b0a0b6 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,33 @@ +# 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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..31a29f8 --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +![Build Status](https://gitlab.com/pages/gitbook/badges/master/build.svg) + +--- + +Example [GitBook] website using GitLab Pages. + +Learn more about GitLab Pages at https://pages.gitlab.io and the official +documentation https://docs.gitlab.com/ce/user/project/pages/. + +--- + + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* + +- [GitLab CI](#gitlab-ci) +- [Building locally](#building-locally) +- [GitLab User or Group Pages](#gitlab-user-or-group-pages) +- [Did you fork this project?](#did-you-fork-this-project) +- [Troubleshooting](#troubleshooting) + + + +## GitLab CI + +This project's static Pages are built by [GitLab CI][ci], following the steps +defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): + +```yaml +# requiring the environment of NodeJS 8.9.x LTS (carbon) +image: node:8.9 + +# 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 latest # fetch latest stable version + - gitbook install # add any requested plugins in book.json + #- gitbook fetch pre # fetch latest pre-release version + #- gitbook fetch 2.6.7 # fetch specific version + +# 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 + only: + - master # this job will affect only the 'master' branch +``` + +## Building locally + +To work locally with this project, you'll have to follow the steps below: + +1. Fork, clone or download this project +1. [Install][] GitBook `npm install gitbook-cli -g` +1. Fetch GitBook's latest stable version `gitbook fetch latest` +1. Preview your project: `gitbook serve` +1. Add content +1. Generate the website: `gitbook build` (optional) +1. Push your changes to the master branch: `git push` + +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 `namespace.gitlab.io`, where `namespace` is +your `username` or `groupname`. This can be done by navigating to your +project's **Settings**. + +Read more about [user/group Pages][userpages] and [project Pages][projpages]. + +## 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. + +## Troubleshooting + +1. 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 + +[ci]: https://about.gitlab.com/gitlab-ci/ +[GitBook]: https://www.gitbook.com/ +[host the book]: https://gitlab.com/pages/gitbook/tree/pages +[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 diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..263112f --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,4 @@ +# Summary + +* [Introduction](README.md) +