{"$schema":"https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json","id":"packages-react","path":"/packages/react","type":"module","module":"packages-react","title":"`@doc-kit/generator-react`","introducedIn":null,"sourceLink":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The website generators for [doc-kit](https://doc-kit.nodejs.org): a static\ndocumentation site, rendered with Preact and bundled with Vite, and the outputs\nthat usually ship with one: the search index, a sitemap, and `llms.txt` files\nfor language models. Install it to build any of these. The JSON outputs come\nwith `@doc-kit/core` and don't need it.","summary":"The website generators for doc-kit: a static documentation site, rendered with Preact and bundled with Vite, and the outputs that usually ship with one: the search index, a sitemap, and `llms.txt` files for language models. Install it to build any of these. The JSON outputs come with `@doc-kit/core` and don't need it.","examples":[],"children":[{"kind":"section","id":"install","name":"Install","title":"Install","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"```sh\nnpm install --save-dev @doc-kit/cli @doc-kit/generator-react\n```\n\nOnce it's installed next to the CLI, the target names below resolve to this\npackage.","summary":"Once it's installed next to the CLI, the target names below resolve to this package.","examples":[{"language":"sh","displayName":null,"code":"npm install --save-dev @doc-kit/cli @doc-kit/generator-react"}],"children":[]},{"kind":"section","id":"usage","name":"Usage","title":"Usage","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"Build the site and its search index into `out/`:\n\n```sh\nnpx @doc-kit/cli generate -t html -t orama-db -i \"docs/**/*.md\" -o out\n```\n\nThe site shows a search box when the search index is built in the same run.\nFor a real project, keep the settings in a\n[configuration file](https://doc-kit.nodejs.org/configuration);\n[Getting started](https://doc-kit.nodejs.org/getting-started) walks through a\nfirst site.","summary":"Build the site and its search index into `out/`:","examples":[{"language":"sh","displayName":null,"code":"npx @doc-kit/cli generate -t html -t orama-db -i \"docs/**/*.md\" -o out"}],"children":[]},{"kind":"section","id":"generators","name":"Generators","title":"Generators","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"| Target          | Writes                                                                                                                                              | Reference                                                            |\n| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |\n| `html`          | The site: a page per input file, `all.html`, `404.html`, their scripts and styles, and copies of `assets/`, `public/` and `static/` (`pathsToCopy`) | [Website](https://doc-kit.nodejs.org/generators/html)                |\n| `section-pages` | A page per section of each module (`fs/readFile.html`), added to the site and sitemap                                                               | [Section pages](https://doc-kit.nodejs.org/generators/section-pages) |\n| `orama-db`      | `orama-db.json`, the search index the site's search box loads                                                                                       | [Search index](https://doc-kit.nodejs.org/generators/orama-db)       |\n| `sitemap`       | `sitemap.xml`, listing every page for search engines                                                                                                | [Sitemap](https://doc-kit.nodejs.org/generators/sitemap)             |\n| `llms-txt`      | `llms.txt`, a link to every page with its description, for language models                                                                          | [llms.txt](https://doc-kit.nodejs.org/generators/llms-txt)           |\n| `llms-txt-full` | `llms-full.txt`, every page's Markdown in one file, each preceded by its URL                                                                        | [llms-full.txt](https://doc-kit.nodejs.org/generators/llms-txt-full) |\n\nThe package also ships `jsx-ast`\n([Page JSX](https://doc-kit.nodejs.org/generators/jsx-ast)), the stage that\nturns each page's API entries into JSX for `html`. It runs whenever `html`\ndoes, so it isn't one of the CLI's targets.","summary":"The package also ships `jsx-ast` (Page JSX), the stage that turns each page's API entries into JSX for `html`. It runs whenever `html` does, so it isn't one of the CLI's targets.","examples":[],"children":[]},{"kind":"section","id":"customizing-the-site","name":"Customizing the site","title":"Customizing the site","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The site's content, look and build are options of `html`, listed in the\n[Website](https://doc-kit.nodejs.org/generators/html#configuring) reference.\n[Customizing the site](https://doc-kit.nodejs.org/customization) walks through\nthem.","summary":"The site's content, look and build are options of `html`, listed in the Website reference. Customizing the site walks through them.","examples":[],"children":[]},{"kind":"section","id":"exports","name":"Exports","title":"Exports","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"| Import                                        | What it is                                                                                                                                                                                  |\n| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `@doc-kit/generator-react/<target>`           | Each generator above, and `jsx-ast`, as the default export. The target names resolve to these, and a custom generator can name one in `dependsOn`.                                          |\n| `@doc-kit/generator-react/html/bundlers/vite` | `createViteBundler(options)`, the default bundler adapter: pass it your Vite configuration and set the result as `html.bundler`.                                                            |\n| `@doc-kit/generator-react/html/ui/*`          | The site's UI source, for theme components that build on it, such as `components/Layout/index.jsx` (the default layout) and `islands/withIsland.jsx` (hydrates a component in the browser). |","summary":"","examples":[],"children":[]}]}