README.md

    Build Status


    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

    GitLab CI

    This project's static Pages are built by GitLab CI, following the steps defined in .gitlab-ci.yml:

    # 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

    Building locally

    To work locally with this project, you'll have to follow the steps below:

    1. Fork, clone or download this project
    2. Install GitBook npm install gitbook-cli -g
    3. Fetch GitBook's latest stable version gitbook fetch latest
    4. Preview your project: gitbook serve
    5. Add content
    6. Generate the website: gitbook build (optional)
    7. 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 and project Pages.

    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

    项目简介

    当前项目暂无项目简介

    发行版本

    当前项目没有发行版本

    贡献者 10

    开发语言