{"repo":"ap0llo/mddocs","free":true,"listed":false,"github":"https://github.com/ap0llo/mddocs","clone":"git clone https://github.com/ap0llo/mddocs.git","description":"A tool to generate documentation as Markdown files","language":"C#","stars":30,"topics":["markdown","csharp","dotnet","api","documentation"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"MdDocs Overview Package NuGet.org MyGet --------------------------- -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Grynwald.MdDocs Grynwald.MdDocs.MSBuild MdDocs is a tool to generate documentation in the form of Markdown documents. It currently supports: - Generating API reference from a .NET assembly and the corresponding XML documentation file - Generating command line help for projects that use the CommandLineParser package for parsing For an example of what the output looks like, have a look at the demoprojects directory. Documentation For documentation on installation and usage, please refer to the corresponding sub-pages: - MdDocs .NET CLI Tool - MdDocs MSBuild Integration - Configuration Building from source ℹ This repository uses git submodules. Use git clone --recursive to check out submodules as well. Building MdDocs from source requires the .NET 7 SDK (at lease version 7.0.101 as specified in global.json) and uses Cake for the build. To run tests, the .NET 6 SDK and a installation of Visual Studio 2022 is requried as well. (this only applies to the MdDocs.MSBuild.IntegrationTest project, all other test project should be executable with only the .NET 7 SDK). To execute the default task, run This will build","default_branch":null,"files":null,"tree":[],"storefront":"/r/ap0llo","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ap0llo/mddocs/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."}