Page JSX

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.

Configuring

Attributes

ref?:string

The Git ref of the "Source Code" link that an entry with a source_link gets under its heading, which points at https://github.com/<repository>/blob/<ref>/<source_link>. The default wins over global.ref, so --git-ref doesn't change it. Default: 'main'.

generateNotFoundPage?:boolean

Whether to build the 404 page. Default: true.

showReadingTime?:boolean

Whether to estimate each page's reading time, such as 1 min read, which the site shows in the page's meta bar. Default: false.

markdown:Object

Your own plugins for the pages. See Markdown plugins.

Output

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.

Index page

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).