DocPensieve
Guide
These pages are read in order. Each one starts from what the previous one set up.
Installation
What you need, and how to set up a documentation project.
First site
Build, serve, and understand what was produced.
Writing pages
Frontmatter, URLs, menu order, links and images.
Versions
Keep the current version and the one being prepared side by side.
Themes
Style the site, and change the classes without touching the HTML.
Deployment
Publish the site, and keep past versions online.
Migrate from 0.2 to 0.3
Move a project from the 0.2 to the 0.3 — what changes on its own, and what to turn on.
When it breaks
The failures this tool actually produces, what causes each one, and the fix — by the symptom you see.
What to know first
The produced site is entirely static. Each page is a complete HTML file, served as is, along with a single stylesheet. Nothing is computed on the reader's side.
This has a consequence to keep in mind throughout: what depends on the moment — a date, a countdown — is frozen at build time, not at reading time. TimeTimer says so explicitly, and a scheduled build is enough to keep it right.