Skip to content

Latest commit

 

History

History

docs

KISS documentation

This folder contains the documentation website used to generate http://help.kisslauncher.com.

Credits

This website was generated from https://github.com/CloudCannon/base-jekyll-template, who were kind enough to open-source a documentation platform.

Develop

The website is built with Jekyll.

Install the dependencies with Bundler:

$ bundle install

Run jekyll commands through Bundler to ensure you're using the right versions:

$ bundle exec jekyll serve

Editing

Posts

  • Add, update or remove a post in the Posts collection.
  • The tutorials page is organised by categories.
  • Change the defaults when new posts are created in _posts/_defaults.md.

Post Series

To create a new series:

  • Add a new document to the sets collection.
  • Set the title and description.

To add a tutorial/post to a series:

  • Add a set field to the tutorial front matter which points to the file name of the desired set without the .md extention. e.g. If I have a set at _sets/getting-started.md I would use this in my tutorial front matter: set: getting-started.
  • Add a set_order field to the tutorial front matter and specify a number. This is the tutorials order in the set.