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 project.
- First site — build, serve, look at what was produced.
- Writing pages — frontmatter, URLs, menu, links, images.
- Versions — several documentation versions, one branch each.
- Themes — style the site, change the classes without touching the HTML.
- Deployment — publish, and keep past versions online.
- Migrate from latest to beta — move a 0.2 project to the 0.3 beta.
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.
DocPensieve