diff --git a/docs/content/docs/features.mdx b/docs/content/docs/features.mdx index aacdad1..2155122 100644 --- a/docs/content/docs/features.mdx +++ b/docs/content/docs/features.mdx @@ -11,7 +11,7 @@ Chronicle is a self-hosted documentation platform built with Vite + Nitro. ## Content - **MDX support** — write documentation in MDX with React component embedding -- **Frontmatter** — `title`, `description`, `order`, `icon`, `lastModified` +- **Frontmatter** — `title`, `short`, `description`, `identifiers`, `order`, `icon`, `lastModified`, `authors`, `draft` - **Directory metadata** — `meta.json` for folder titles, ordering, and sidebar config - **Remark plugins** — directives, admonitions, image resolution, link resolution, mermaid, reading time - **Syntax highlighting** — powered by Shiki via Apsara CodeBlock @@ -40,6 +40,7 @@ Chronicle is a self-hosted documentation platform built with Vite + Nitro. - **Default theme** — sidebar + content layout with sub-navigation bar - **Paper theme** — book-style single-column with reading progress +- **Fanfold theme** — continuous-form line printer paper, monospace throughout - **Dark/light mode** — system preference or manual toggle ## SEO & AI diff --git a/docs/content/docs/frontmatter.mdx b/docs/content/docs/frontmatter.mdx index 8914845..38a811a 100644 --- a/docs/content/docs/frontmatter.mdx +++ b/docs/content/docs/frontmatter.mdx @@ -51,8 +51,9 @@ The sidebar shows `SPP` and keeps the full title on the link's tooltip. Headings breadcrumbs, the browser tab and search all keep using `title`. Pages that set no `short` fall back to their title, so this is opt-in per page. -Honoured by the `fanfold` theme, whose rail is narrow enough to need it. The -`default` and `paper` themes ignore it and always show `title`. +Honoured by the `fanfold` theme, whose rail is narrow enough to need it, and by +its printed header, where the trail reads `Protocols / SPP` rather than the full +title. The `default` and `paper` themes ignore it and always show `title`. ### description @@ -62,6 +63,27 @@ Optional meta description for the page. Used in SEO metadata. description: Step-by-step installation instructions ``` +### identifiers + +Optional list of extra lines identifying the page — the standard it implements, a +package, a command. Each entry is printed as written, so the page decides both +the facts and their order. + +```yaml +title: Space Packet Protocol +identifiers: + - CCSDS 133.0-B-2 * Space Packet Protocol + - pkg/spp * astro spp +``` + +Use it for pages whose readers already know them by something other than a title. +A theme cannot work these out for itself, which is why they live in the page. + +Honoured by the `fanfold` theme, which prints them in its header block under the +breadcrumb trail. A page that sets none keeps the lines that theme derives on its +own — the site name, the section, and the page's path. The `default` and `paper` +themes ignore the field. + ### order Controls the page's position in sidebar navigation. Lower numbers appear first. @@ -118,6 +140,19 @@ authors: - Sam Patel ``` +### draft + +Set `draft: true` to keep a page out of the site. It is dropped from the +navigation tree, so it does not appear in the sidebar, in breadcrumbs, in search, +or in the previous/next links. + +```yaml +draft: true +``` + +The file stays where it is, so this is the way to leave a page in the repository +while it is still being written. + A single author can be written without the list: ```yaml diff --git a/docs/content/docs/themes.mdx b/docs/content/docs/themes.mdx index ccb29da..238a335 100644 --- a/docs/content/docs/themes.mdx +++ b/docs/content/docs/themes.mdx @@ -57,7 +57,7 @@ theme: - Minimal, distraction-free design - Reading progress tracking - Optimized typography for long content -- Light mode only (dark mode toggle is disabled) +- Light and dark mode ## Fanfold Theme @@ -77,10 +77,20 @@ theme: ### Features -- Header block prints the breadcrumb trail, site name, path, and a page counter +- Header block prints the breadcrumb trail and a page counter, then whatever the + page gives as [`identifiers`](/docs/frontmatter) — falling back to the site + name and path - Page title set in a dot-matrix face that steps down in size as titles get longer -- Code blocks print as ruled listings with a line-number gutter -- Tables print as field maps with no cell borders +- Everything on the sheet is held to one 80-column measure, so prose, tables, + code and rules share the same edges +- Code blocks print as ruled listings with a line-number gutter. A fence with no + language is treated as a drawing rather than a listing and gets no numbers, so + ASCII diagrams keep their own alignment +- Tables print as field maps with no cell borders. A wide table with a column of + prose in it has its columns measured at build time, and folds that column under + each row behind a toggle, so the paragraph reads at the full width of the sheet + instead of a narrow column +- Uses a page's [`short`](/docs/frontmatter) label in the rail and the header trail - Its own landing page: a masthead over a register of every section - Light and dark mode