1.8 KiB
{% include linkrefs.html %}
Overview
This site provides documentation, training, and other notes for the Jekyll Documentation theme. There's a lot of information about how to do a variety of things here, and it's not all unique to this theme. But by and large, understanding how to do things in Jekyll depends on how your theme is coded. Out of the box, Jekyll's theme is pretty basic.
Survey of features
Some of the more prominent features of this theme include the following:
- Bootstrap framework
- Sidebar with page hierarchy
- PDF generation
- Notes, tips, and warning information notes
- Tags
- Single sourcing
- Emphasis on pages, not posts
I'm using this theme for my documentation projects, building about 15 different outputs for various products, versions, languages, and audiences from the same set of files. This single sourcing requirement has influenced how I constructed this theme.
For more discussion about the available featuers, see {{doc_supported_features}}.
Getting started
To get started, see these three topics:
- {{doc_getting_started}}
- {{doc_configuration_settings}}
- {{doc_customize_the_theme}}
After that, the topics aren't in any particular order.
PDF Download
If you would like to download this help file as a PDF, you can do so here. The PDF is comprehensive of all the content in the online help.
The PDF contains a timestamp in the header indicating when it was last generated. If you download a PDF, keep in mind that it may go out of date quickly. Always compare your PDF timestamp against the online help timestamp (which you can find in the footer).