{"repo":"dadhi/CsToMd","free":true,"listed":false,"github":"https://github.com/dadhi/CsToMd","clone":"git clone https://github.com/dadhi/CsToMd.git","description":"Visual Studio extension and dotnet CLI tool to generate the Markdown Docs from the C# Tests keeping your Docs and Tests in sync!","language":"C#","stars":47,"topics":["tools","visualstudio2017","extension","filegenerator","markdown","documentation-tool","documentation-generator","documentation","samples","runnable"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"CsToMd - CsToMd - Idea and Overview - Dotnet CLI tool - Ad-hoc document generation - Build integration - Visual Studio extension - How to use Idea and Overview The dotnet CLI tool to convert C# file with Unit Tests into the Markdown documentation. The idea is to have a normal C# .cs file with the special comments / md , md / , and //md which will be stripped when converting the file into the respective Markdown .md file. There are a couple of additional features but this is basically it. Now you have the documentation always up-to-date with the runnable samples in the normal .NET Test library project with NUnit, XUnit, etc. You may check the DryIoc documentation project for the real-world case example. The additional features: - Directive to automatically wrap code in code fence with the optional language, e.g. add //md code:csharp , or just //md code: to add fences, and //md code:-- to stop adding fences. The directive may be used multiple times through the file. - Converting the section outlined with //md{ and //md} comments into the collapsed markdown details. - The optional cstomd.config file in the folder with the lines starters to be removed completely from the generated documentation file. Dotnet CLI tool The dotnet-cstomd is a dotnet CLI tool. It may be called from the command line and from the MSBuild scripts ( enabling the document generation in the build pipeline ). I addition the dotnet tool enables the documentation development in the Visual Studio Code . Ad-hoc ","default_branch":null,"files":null,"tree":[],"storefront":"/r/dadhi","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/dadhi/CsToMd/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."}