{"$schema":"https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json","id":"generators-jsx-ast","path":"/generators/jsx-ast","type":"module","module":"generators-jsx-ast","title":"Page JSX","introducedIn":null,"sourceLink":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"The `jsx-ast` stage turns each page's API entries into the JSX that the\n[website](https://doc-kit.nodejs.org/generators/html) renders. It runs whenever\nyou build the site, since `html` depends on it. With\n[section pages](https://doc-kit.nodejs.org/generators/section-pages),\n`section-pages` runs between `metadata` and `jsx-ast`, so the section pages are\nbuilt here like any other page.","summary":"The `jsx-ast` stage turns each page's API entries into the JSX that the website renders. It runs whenever you build the site, since `html` depends on it. With section pages, `section-pages` runs between `metadata` and `jsx-ast`, so the section pages are built here like any other page.","examples":[],"children":[{"kind":"section","id":"configuring","name":"Configuring","title":"Configuring","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"* `ref` {string} The Git ref of the \"Source Code\" link that an entry with a\n  `source_link` gets under its heading, which points at\n  `https://github.com/<repository>/blob/<ref>/<source_link>`. The default wins\n  over `global.ref`, so `--git-ref` doesn't change it. **Default:** `'main'`.\n* `generateNotFoundPage` {boolean} Whether to build the `404` page.\n  **Default:** `true`.\n* `showReadingTime` {boolean} Whether to estimate each page's reading time,\n  such as `1 min read`, which the site shows in the page's meta bar.\n  **Default:** `false`.\n* `markdown` {Object} Your own plugins for the pages. See\n  [Markdown plugins](https://doc-kit.nodejs.org/configuration#markdown-plugins).","summary":"","examples":[],"children":[]},{"kind":"section","id":"output","name":"Output","title":"Output","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"Each page is emitted as `{ data, headings, readingTime, content }`: the page's\nhead entry, its table of contents, the optional reading time, and the processed\ncontent serialized to JSX code as one fragment. The page layout is not part of\nthe content — the `html` generator wraps each page in `<Layout>`, and assembles\n`all.html` from the module pages' content (see its `generateAllPage` option)\nrather than building every module a second time here.","summary":"Each page is emitted as `{ data, headings, readingTime, content }`: the page's head entry, its table of contents, the optional reading time, and the processed content serialized to JSX code as one fragment. The page layout is not part of the content — the `html` generator wraps each page in `<Layout>`, and assembles `all.html` from the module pages' content (see its `generateAllPage` option) rather than building every module a second time here.","examples":[],"children":[]},{"kind":"section","id":"index-page","name":"Index page","title":"Index page","scope":"module","overloadOf":null,"stability":null,"added":[],"deprecated":[],"removed":[],"napiVersion":[],"changes":[],"description":"`index.html` is generated when an `index` document is part of the input, and\nis rendered from that document like any other page. An MDX `index` document\ncan render the stability overview of every module by using the built-in\n`<DocumentationIndex />` component (see\n[MDX pages](https://doc-kit.nodejs.org/writing-docs#mdx-pages)).","summary":"`index.html` is generated when an `index` document is part of the input, and is rendered from that document like any other page. An MDX `index` document can render the stability overview of every module by using the built-in `<DocumentationIndex />` component (see MDX pages).","examples":[],"children":[]}]}