Edit me

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 set up to push out documentation for multiple projects all from the same source. You can also share content across projects.

Survey of features

Some of the more prominent features of this theme include the following:

  • Bootstrap framework
  • Sidebar for table of contents
  • Top navigation bar with drop-down menus
  • PDF generation (through Prince XML utility)
  • Build scripts to automate the workflow
  • Notes, tips, and warning information notes
  • A nifty system for creating links to different pages
  • Tags for alternative nativation
  • Content sharing across projects
  • Emphasis on pages, not posts
  • Relative (rather than absolute) link structure, so you can push the outputs anywhere and easily view them

I’m using this theme for my documentation projects, building about 20 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 features, see Supported features.

Getting started

To get started, see these three topics:

  1. 1. Build the default project
  2. 4. Set the configuration options
  3. 2. Add a new project

PDF Download Option for Help Material

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.

Tags: getting_started