Generate Markdown documentation
Markdown documentation is generated as a set of plain text files using the Markdown syntax. This lightweight format is easy to read, edit, and convert, making it ideal for developers, version control systems, and workflows that require simple, portable documentation. Because it is structured yet human-readable, Markdown is also AI-friendly, enabling efficient parsing, analysis, and content reuse by automated tools and AI systems.
HelpNDoc can generate Markdown documentation directly from your project. The generation process can be performed quickly using the default settings, or with advanced configuration options through the documentation generation dialog.
Quick Markdown generation
To quickly generate Markdown documentation using the current project settings:
- Go to the Home ribbon tab.
- Click the bottom part of the Generate Help button.
- Select Markdown Documentation from the available output formats.
This will immediately create Markdown files using the predefined settings for the project.
Advanced generation options
If you need more control over the Markdown output:
- Go to the Home ribbon tab.
- Click the top part of the Generate Help button.
- In the Generate Documentation dialog, make sure that Build Markdown Documentation is checked in the build list.
From here, you can adjust generation settings such as output location, template, or options specific to the Markdown format. See: Customize Markdown documentation settings