https://github.com/grobmeier/docs
Docs for Cicada
https://github.com/grobmeier/docs
Last synced: about 1 year ago
JSON representation
Docs for Cicada
- Host: GitHub
- URL: https://github.com/grobmeier/docs
- Owner: grobmeier
- License: mit
- Created: 2017-04-18T13:19:20.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-25T18:08:19.000Z (about 9 years ago)
- Last Synced: 2025-02-15T06:22:31.214Z (over 1 year ago)
- Language: CSS
- Size: 320 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.html
- License: LICENSE
Awesome Lists containing this project
README
# Edition
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 was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.
Find more templates and themes at [Jekyll Tips](http://jekyll.tips/templates/).
Learn Jekyll with step-by-step tutorials and videos at [Jekyll Tips](http://jekyll.tips/).
## 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.