Home

C# Documentation Generator

This project was originally created to easily create GitHub-compatible markdown documentation from C# libraries.
However, during development I happened to choose an approach that was more flexible than I originally anticipated.
As such, the tool is now capable of generating not only markdown documentation, but target pretty much any text-based output format.

Features

• Powerful templating language with conditions and parameterized dynamic elements
• Automatically generates relative links to other documentation files and static resources
• Online documentation for external types can be referenced
• Templates can be nested and reused in different contexts during the generation process
• Allows for automatic, template-based generation of table-of-contents files
• Analyses compiled inline XML-documentation files and makes their content accessible
• Customizable global variables for use in templates

Planned Features

• Proper localization support
• Custom text editor for creating and editing templates

Further reading

Generating Documentation

Generation Settings

Templates (Examples)

Contexts

Properties

Design Principles