@doc-kit/generator-react
The modern web generators for doc-kit: a server-rendered, client-hydrated documentation site with search, plus the machine-readable formats that usually accompany one.
Install
npm install --save-dev @doc-kit/core @doc-kit/generator-react
Generators
| Target | Output |
|---|---|
html | The full documentation site — server-rendered pages hydrated with Preact, bundled with Vite. |
orama-db | An Orama search index, consumed by the html site's search box. |
llms-txt | An llms.txt index for Large Language Models. |
llms-txt-full | Every page's Markdown in one llms-full.txt, for Large Language Models. |
sitemap | A sitemap.xml for search engines. |
section-pages | The html site and sitemap, plus one page per section of every module. |
The package also provides jsx-ast, the intermediate stage that turns parsed
API metadata into JSX; it runs automatically when html needs it and is not a
target you invoke yourself.
Usage
npx @doc-kit/cli generate -t html -t orama-db -i "docs/**/*.md" -o out
The html generator is deeply customizable — project name, page titles,
<head> markup, sidebar and navigation bar, theme components, and even the
bundler are all configuration. See the html generator
reference and the
doc-kit documentation for the full
options.