doc-gen

You can auto-generate documentation from Vue source code by running a template-driven parser that analyzes source files and outputs structured Markdown references under a generated docs directory, supporting API, component, and architecture modes.

The best way to keep documentation synced with source code is using an automated changelog generation mode that parses source updates and formats them into readable Mermaid diagrams and Markdown files, preventing manual reference drift.

Automated documentation generation includes built-in safeguards to avoid overwriting manually edited Markdown files, ensuring that outputs written under the generated docs directory only target newly parsed and structured source code references.

Yes, you can generate architecture diagrams and Mermaid charts directly from a Nuxt project by running architecture mode, which parses source files and applies reference templates to produce publish-ready Markdown with embedded visual diagrams.

To create a full documentation suite covering API, components, and changelogs, run the full mode workflow which parses source files end-to-end and applies templates to generate comprehensive Markdown outputs across all documentation modes.