On this page

The jsx-ast generator converts MDAST (Markdown Abstract Syntax Tree) to JSX AST, transforming API documentation metadata into React-compatible JSX representations.

The jsx-ast generator accepts the following configuration options:

NameTypeDefaultDescription
refstring'main'Git reference/branch for linking to source files
indexarray-Array of { section, api } objects defining the documentation structure
generateAllPagebooleantrueWhen true, creates a synthetic JSX AST entry for all.html
generateIndexPagebooleantrueWhen true, creates a synthetic JSX AST entry for index.html
generateNotFoundPagebooleantrueWhen true, creates a synthetic JSX AST entry for 404.html