Skip to content

open-docs 0.2.0

Choose a tag to compare

@PaulDotterer PaulDotterer released this 02 Jun 07:45
· 103 commits to main since this release

Generic, container-shipped documentation site — bring a folder of Markdown, it brings the chrome.

Added

  • AGENTS.md — a self-contained authoring spec for AI agents (the folder→nav model, every Markdoc tag with exact syntax, the parser gotchas, and best practices), linked from the top of the README. Copy it into your content repo so agents can author correct pages without reading the source.
  • {% boost weight=N %} Markdoc tag — invisibly weights a passage in the search index for the rare case heading weights aren't enough.
  • A Search documentation page explaining what's indexed and how ranking works.

Changed

  • Search tuned for docs. Headings now outrank body text (h1/h2/h3 weighted), navigational chrome (prev/next, the Mermaid placeholder) is excluded from the index, and ranking favours exact matches without penalising long pages.
  • theme-color follows your theme. The mobile browser chrome tint is derived from the --primary token in both light and dark mode — no separate flag to keep in sync.

Fixed

  • Inline code no longer breaks mid-identifier at a hyphen inside table cells (e.g. -server-url, data/open-secret.db).
  • The container build runs svelte-kit sync before vite build, eliminating the startup tsconfig.json warning.

Removed

  • PUBLIC_THEME_COLOR — superseded by deriving the tint from --primary.

docker run --rm -p 3000:3000 -v ./content:/content:ro ghcr.io/manchtools/open-docs:0.2.0