Skip to content
DocPensieve
0.3.0-beta.1

Guide

These pages are read in order. Each one starts from what the previous one set up.

  1. Installation — what you need, and how to set up a project.
  2. First site — build, serve, look at what was produced.
  3. Writing pages — frontmatter, URLs, menu, links, images.
  4. Versions — several documentation versions, one branch each.
  5. Themes — style the site, change the classes without touching the HTML.
  6. Deployment — publish, and keep past versions online.
  7. 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.