Documentation on how we do things.
In pretty form at: playbook.stsiinc.com
The basic model is as follows:
-
Topics: A topic is the higher-level item, corresponding to one larger guide, rendered as a single long page.
-
Sections: Each topic is comprised of multiple sections, each rendered under a heading.
To make edits, add or update files in the _sections directory. Note: the formatting is based on markdown syntax.
Sections will be ordered by the alpha sort of the file name. Therefore, by prefixing file names with a number, we can control the order.
To add a topic:
- The corresponding file must be added in the
_topicsdirectory. - The
_config.ymlfile must be edited to add a value underdefaults->scope. See other examples to map the directory in_sectionsto the topic.
Content can be edited directly in GitHub. To do more complex work such as changing templates, styles, etc. you can run locally on the desktop.
See jekyll docs for more detail, but the TLDR is:
- Install ruby if not present
gem install jekyll bundlerbundle installjekyll serve