docs-kit

docs-kit

Shared docs chrome for Rails, in Phlex.

The shell, sidebar, theme switcher, syntax highlighting, multi-language examples, and an automatic table of contents — configure it once, write your pages, deploy with one workflow. This site is built with docs-kit.

Gemfile
gem "docs-kit"
One shared shell

The topbar, drawer sidebar, theme switcher, and content column — identical across every site, driven by config.

Syntax + multi-language examples

Rouge highlighting with a light/dark theme pair, and tabbed code with a sticky global language choice.

Registry-driven nav & search

One `page` declaration feeds the sidebar, the search index, and llms.txt — they never drift from your pages.

Markdown twins + llms.txt

Every page has a .md twin and an llms.txt index for free, derived from the same render your readers see.

API-reference kit

DocsUI::Endpoint / FieldTable / RequestExample turn one declaration into a badge, tables, and a tab per client.

Deploy with one workflow

Scaffold a deployable site with `docs-kit new`, or add it to an existing Rails app with the install generator.