{"repo":"hailstorm75/ModularDoc","free":true,"listed":false,"github":"https://github.com/hailstorm75/ModularDoc","clone":"git clone https://github.com/hailstorm75/ModularDoc.git","description":"Modular documentation generator for .NET libraries. Currently supporting Markdown only for GitHub, GitLab, and Bitbucket","language":"C#","stars":144,"topics":["markdown","documentation-generator","csharp","netcore","netframework","netstandard","wiki","reflection","dotnet","bitbucket"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Description The most modular plugin-based documentation generator for your .NET libraries (currently officially supporting C# 9 and lower). I'm writing a Bachelor's thesis about this project. What does modular mean? Generating documentation isn't for everyone. And those who do need it can have very specific needs. That's why ModularDoc is written in such a way, that almost everything is decoupled and can be replaced by you! But that is for the most extreme cases. The most important feature is pluginability. Using plugins you chose how your documentation is generated. A plugin determines what is the required input, what is/are the output format(s), how the documentation is structured and processed. As of now, these are the available plugins: - Markdown for Git - generates Markdown documentation for GitHub, GitLab, and Bitbucket Adding new plugins will extend the functionality of the tool. E.g., generate Markdown for DocFX, generate diagrams only, generate HTML... There no simple way of describing ModularDoc, as it is very abstract, and defined by the plugins available. Plugin: Markdown for Git - This plugin uses reflection for gathering types and their members from assemblies and reads the XML documentation generated on your project build - The generated output is a Markdown file per type (interface, class, struct, record, enum...) - It also provides inheritance diagrams via MermaidJS - The structure of the documentation is inspired by Doxygen, and is not configurable - The fi","default_branch":null,"files":null,"tree":[],"storefront":"/r/hailstorm75","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/hailstorm75/ModularDoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}