Skip to content

Releases: manchtools/open-docs

open-docs 0.2.5

Choose a tag to compare

@PaulDotterer PaulDotterer released this 05 Jun 11:59

Fixed

  • Wide content no longer breaks out of callouts. A wide table (or long code block) inside a {% callout %} used to push the callout past the page column and clip the overflowing columns with no scrollbar. It now scrolls within the callout. Audited the other content-wrapping blocks (steps, tabs, cards, accordion, screenshot) — all already handle wide content correctly.

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

open-docs 0.2.4

Choose a tag to compare

@PaulDotterer PaulDotterer released this 03 Jun 17:02

Fixed

  • Adaptive favicon. The default favicon now follows the OS color scheme via an embedded prefers-color-scheme media query — indigo on a light tab strip, a lighter indigo on a dark one — and switches live (no refresh) in browsers that support SVG favicons.

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

open-docs 0.2.3

Choose a tag to compare

@PaulDotterer PaulDotterer released this 02 Jun 14:53

Fixed

  • theme.css overrides now always win. The default design tokens were unlayered — the same footing as an operator's theme.css — so a Vite chunk-ordering quirk could let the container defaults clobber the override (contrary to the docs' "your rules always win"). The defaults now live in @layer base, so a plain-:root theme.css wins deterministically, regardless of chunk order. Authors keep writing plain :root / .dark; the :root:root workaround is no longer needed.
  • Multi-word search highlighting. Every word of a multi-word query is now highlighted on the destination page — previously only the rare contiguous phrase matched.

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

open-docs 0.2.2

Choose a tag to compare

@PaulDotterer PaulDotterer released this 02 Jun 13:26

Added

  • Search-term highlighting. Following a search result now highlights the matched term(s) on the destination page — wrapped in themed <mark>s that match the in-palette excerpt highlights — and scrolls the first hit into view. Built on Pagefind's own highlighter via a ?highlight= URL param; dev builds (no index) quietly skip it and behave as before.

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

open-docs 0.2.1

Choose a tag to compare

@PaulDotterer PaulDotterer released this 02 Jun 12:34

A small UI release — tables, footer, and search polish.

Changed

  • Tables now render via shadcn-svelte. The table/thead/tbody/tr/th/td Markdoc nodes map to shadcn's Table parts, and Table.Root wraps each table in a horizontal scroll container — so a wide table scrolls sideways within its own box on small screens instead of overflowing the page. Column alignment is preserved and inline code stays whole.
  • The footer scrolls away on mobile. Below md it lives in the scroll area (sliding away with the content, resting at the bottom on short pages) instead of pinning to the small viewport. Desktop keeps the pinned footer.

Fixed

  • Search palette focuses its input on open — a single tap is now enough to start typing (touch devices previously needed a second tap to place the cursor).

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

open-docs 0.2.0

Choose a tag to compare

@PaulDotterer PaulDotterer released this 02 Jun 07:45

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

v0.1.1

Choose a tag to compare

@PaulDotterer PaulDotterer released this 01 Jun 18:08

Fixes

Rebrand environment variables now take effect. PUBLIC_BRAND_NAME,
PUBLIC_SITE_TITLE, PUBLIC_BRAND_TAGLINE, PUBLIC_SITE_DESCRIPTION,
PUBLIC_REPO_URL, and PUBLIC_THEME_COLOR were silently ignored because
Vite's default envPrefix (VITE_) didn't expose
import.meta.env.PUBLIC_*. They're now baked into the build — including
the values passed at the container's build-at-start step. (7d14edc)

⚠️ v0.1.0 carries this bug; use 0.1.1 or later.

Image

docker run --rm -p 3000:3000 -v ./content:/content:ro \
  -e PUBLIC_BRAND_NAME="My Project" \
  ghcr.io/manchtools/open-docs:0.1.1

Full changelog: v0.1.0...v0.1.1