Contributing

gtk-kt

Please head over to the GitLab to contribute to the code base.

Website

Below contains information taken from the inital README.md for the website.

Table of Contents generated with DocToc

• GitLab CI
• Building locally
• Troubleshooting

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 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
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.

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.