Version 3.0 of my Documentation theme for Jekyll is now available. You can download the source code from the theme’s Github repo.
Here’s an example output: http://idratherbewriting.com/documentation-theme-jekyll/.
The theme is built for single sourcing, so the default theme has a couple of outputs: Designers and Writers. The Designers output has detailed instructions for working with the theme.
The Writers output is a slightly scaled back version of the same content (eliminating some explanations of how the theme works), with another theme applied.
The Getting started page in the theme explains how to build the two outputs.
Some of the more prominent features of the theme include the following:
For a more detailed list of supported features, see Supported features.
To get started using the theme, see Getting started with this theme.
Jeyll is amazingly flexible. You can build pretty much whatever you want, if you’re clever enough and have good web development skills. I’m not a professional web developer, but I was able to leverage some existing frameworks like Bootstrap and some jQuery plugins like Navgoco to build this theme.
I think the theme does most everything that a help authoring tool or a DITA-authoring tool can do, within reason. I’ve been using this theme for some months now on documentation projects at my work.
The thing with Jekyll is that you have to build the functionality you want. It’s not enough to say “Can Jekyll do this or that?” It’s more like, “Is there a Jekyll theme that contains the functionality that does this or that?”
The theme is open source and freely available for you to use. If you have feedback, suggestions, or other comments, please let me know.
What’s next for the theme? In the next version, I want to add the following:
Get new posts delivered straight to your inbox.
I'm a technical writer based in the California San Francisco Bay area. Topics I write about on this blog include the following technical communication topics: Swagger, agile, trends, learning, plain language, quick reference guides, tech comm careers, and certificate programs. I'm interested in information design, API documentation, visual communication, information architecture and findability, and more. If you're a professional or aspiring technical writer, be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.