https://github.com/cloudcannon/edition-jekyll-template

:books: Product documentation template for Jekyll
https://github.com/cloudcannon/edition-jekyll-template

jekyll jekyll-template jekyll-theme

Last synced: 1 day ago
JSON representation

:books: Product documentation template for Jekyll

• Host: GitHub
• URL: https://github.com/cloudcannon/edition-jekyll-template
• Owner: CloudCannon
• License: mit
• Created: 2016-07-14T03:38:28.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T11:23:14.000Z (5 months ago)
• Last Synced: 2024-12-21T02:04:59.186Z (1 day ago)
• Topics: jekyll, jekyll-template, jekyll-theme
• Language: SCSS
• Homepage: https://long-pig.cloudvent.net/
• Size: 292 KB
• Stars: 358
• Watchers: 15
• Forks: 275
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.html
  • License: LICENSE

Awesome Lists containing this project

README

        
# Edition [ LEGACY TEMPLATE NO LONGER MAINTAINED ]

Product documentation template for Jekyll. Browse through a [live demo](https://long-pig.cloudvent.net/).

Start documenting your product, application, service or website with this configurable theme.

![Edition template screenshot](images/_screenshot.png)

Edition was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.

Find more templates, themes and step-by-step Jekyll tutorials at [CloudCannon Academy](https://learn.cloudcannon.com/).

[![Deploy to CloudCannon](https://buttons.cloudcannon.com/deploy.svg)](https://app.cloudcannon.com/register#sites/connect/github/CloudCannon/edition-jekyll-template)

## Features

* Two column layout

* Full text search

* Pre-styled components

* Auto-generated navigation based on category

* Optimised for editing in [CloudCannon](http://cloudcannon.com/)

* 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](https://app.cloudcannon.com/) or Jekyll locally).

## Develop

Edition was built with [Jekyll](http://jekyllrb.com/) version 3.3.1, but should support newer versions as well.

Install the dependencies with [Bundler](http://bundler.io/):

~~~bash

$ bundle install

~~~

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

~~~bash

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