Core Guides
Practical guides for customizing the docsgen core engine. Learn how to control page templates, filter and organize output, document React components, and write effective JSDoc comments.
- Customize output - Change what appears on generated pages and how content is structured.
- Organize symbols - Filter, remap, and order categories to match your project's conventions.
- React support - Take advantage of automatic component detection and props documentation.
- Better JSDoc - Write comments that produce rich, useful generated documentation.
Available Guides
Customizing Page Templates
Toggle page sections, replace them with custom renderers, or override entire page templates. Includes practical examples of building minimal and extended page layouts.
Filtering and Organizing Output
Control which symbols get documented and how they are categorized. Covers @exclude, exclude predicates,
kindMapper, nameMapper, fileNameMapper, category ordering, and @docs for supplementary files.
Documenting React Components
How docsgen detects React components, generates props tables, and handles hooks. Includes setting up a "Hooks" category and documenting component libraries.
Writing Effective JSDoc
Best practices for writing JSDoc and TSDoc comments that produce great documentation. Covers descriptions, parameters, return values, examples, and extended tags.
For reference documentation on the core engine, see:
- Core Overview for the public API and architecture.
- Page Templates for the built-in template reference.
- TypeDoc Integration for TypeDoc configuration details.
