1.9 KiB
title, permalink, audience, tags, keywords, last_updated, summary
| title | permalink | audience | tags | keywords | last_updated | summary |
|---|---|---|---|---|---|---|
| Documentation theme for Jekyll | / | writer, designer | getting-started |
{% include linkrefs.html %}
This is a Jekyll theme intended for documentation projects. What makes this theme unique is the approach in using Jekyll for single sourcing, that is, producing multiple outputs from the same theme. For example, you might have 3 different help systems that you're generating from the same Jekyll project files. More than anything, this Jekyll theme shows you how to use Jekyll for documentation projects from the perspective of a technical writer.
Intended audience
Although this theme could be used for any website, I'm assuming that my main audience involves technical writers. Very few technical writers are even aware of Jekyll as a platform, let alone how to use it for tech comm scenarios. The instructions for this theme, therefore, are a little more extensive because they discuss a lot of Jekyll basics as well.
Supported tech comm features with Jekyll
As far as I can tell, Jekyll supports most of the features a technical writer needs to author and publish content. See {{supported_features}} for an extensive list. Most importantly, using Jekyll allows you to take full advantage of a modern web development platform.
Theme features
This theme specifically provides the following:
- Bootstrap framework
- Font Awesome
- Integrated search
- Navigation sidebar with three navigation levels
- Top navigation with single list links and drop-down links
- PDF integration with Prince (no Prince license included)
Getting started
To get started, see {{getting_started}}. It explains how to create a new project.
Questions
Feel free to ask me a question if there's something I haven't addressed here.
Tom Johnson
tomjohnson1492@gmail.com
idratherbewriting.com