Luscombe Group Wiki

Working on the site locally

To work on the site locally, run this docker command in the repository:

docker run \
    -it \
    --rm \
    -v $(pwd):/apps \
    -p 4000:4000 \
    alpine/bundle:2.7.2 \
    /bin/bash -c "bundle install; bundle exec jekyll serve --host 0.0.0.0"

The site will be accessible at http://127.0.0.1:4000. Any changes you make to the files will automatically trigger a rebuild, the results of which can be seen by refreshing the page.

Edition

Product documentation template for Jekyll. Browse through a live demo. Start documenting your product, application, service or website with this configurable theme.

Edition was made by CloudCannon, the Cloud CMS for Jekyll.

Find more templates, themes and step-by-step Jekyll tutorials at CloudCannon Academy.

Features

• Two column layout
• Full text search
• Pre-styled components
• Auto-generated navigation based on category
• Optimised for editing in CloudCannon
• Change log
• RSS/Atom feed
• SEO tags
• Google Analytics

Setup

1. Add your site and author details in _config.yml.
2. Get a workflow going to see your site's output (with CloudCannon or Jekyll locally).

Develop

Edition was built with Jekyll version 3.3.1, but should support newer versions as well.

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

Edition is already optimised for adding, updating and removing documentation pages in CloudCannon.

Documentation pages

• Add, update or remove a documentation page in the Documentation collection.
• Change the category of a documentation page to move it to another section in the navigation.
• Documentation pages are organised in the navigation by category, with URLs based on the path inside the _docs folder.

Change log

• Add, update or remove change log entries from your posts.
• Tag entries as minor or major in the front matter.

Search

• Add excluded_in_search: true to any documentation page's front matter to exclude that page in the search results.

Navigation

• Change site.show_full_navigation to control all or only the current navigation group being open.