open-docs
open-docs is a reusable, container-shippable documentation site. Drop your Markdown (or Markdoc) files into a directory, point a container at it, and you have a searchable, dark-mode-friendly, syntax-highlighted docs site — no build step to configure, no framework to learn.
The site you are reading right now is open-docs rendering its own documentation. Everything here ships inside the default container image, so a fresh docker run with no content mounted lands on these pages.
Why it exists
Most documentation generators are a dependency you add to a repository and build yourself. open-docs is the opposite: a generic image you mount content into. The same published image serves any docset — you bring the Markdown, it brings the chrome.
That makes it a good fit when you want to:
- Stand up docs for a project without adding a toolchain to its repo.
- Run an internal handbook or knowledge base from a folder of Markdown.
- Keep content and presentation cleanly separated.
What you get
- Folder-derived navigation. The sidebar is built from your directory tree — there is no nav file to keep in sync. See Navigation.
- Full-text search, prebuilt at deploy time with Pagefind — tuned for docs; see Search.
- Light / dark mode with a toggle in the top bar.
- Syntax highlighting via Shiki and diagrams via Mermaid. See Code & diagrams.
- Custom theming from a single
theme.cssyou drop next to your content. See Theming. - Rebranding by environment variable — name, logo, colors, repo link — so one image serves many sites. See Configuration.
- Rich content blocks — callouts, tabs, screenshots — on top of plain Markdown. See Callouts & tabs.
Next steps
Head to the Quick start to get a site running in under a minute, then read Content layout to learn how your files become pages.