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. As a result, these additional details are provided.
The instructions here are geared towards technical writers working on documentation. You may have a team of one or more technical writers working on documentation for multiple projects. You can use this same theme to author all of your documentation for each of your products. The theme is built to accommodate documentation for multiple products on the same site.
Survey of features
Some of the more prominent features of this theme include the following:
- Bootstrap 5 framework, with a sidebar that slides out on small screens
- Navgoco multi-level sidebar for table of contents
- Ability to specify different sidebars for different products
- Top navigation bar with drop-down menus
- Notes, tips, and warning information notes
- Tags for alternative navigation
- Landing page layouts built with Bootstrap cards and tabs (see the Products menu)
- Breadcrumbs generated from the sidebar
- Search, tags, PDF output, and other documentation features
Getting started
To get started, see Getting Started.