{"id":38197161,"url":"https://github.com/ap0llo/mddocs","last_synced_at":"2026-01-17T00:24:19.230Z","repository":{"id":34300858,"uuid":"156100675","full_name":"ap0llo/mddocs","owner":"ap0llo","description":"A tool to generate documentation as Markdown files","archived":false,"fork":false,"pushed_at":"2025-05-13T17:24:38.000Z","size":1942,"stargazers_count":28,"open_issues_count":29,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-09-15T13:36:09.596Z","etag":null,"topics":["api","csharp","documentation","dotnet","markdown"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ap0llo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-11-04T16:15:17.000Z","updated_at":"2025-08-25T16:44:31.000Z","dependencies_parsed_at":"2023-11-14T23:30:41.303Z","dependency_job_id":"2f6d2ce7-0970-4e86-9a42-c275c8c152eb","html_url":"https://github.com/ap0llo/mddocs","commit_stats":{"total_commits":799,"total_committers":5,"mean_commits":159.8,"dds":"0.49687108886107634","last_synced_commit":"5c8aeaac8ec1ff6b9a67730de1735d4870ef14d6"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/ap0llo/mddocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ap0llo%2Fmddocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ap0llo%2Fmddocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ap0llo%2Fmddocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ap0llo%2Fmddocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ap0llo","download_url":"https://codeload.github.com/ap0llo/mddocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ap0llo%2Fmddocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28490051,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T23:55:29.509Z","status":"ssl_error","status_checked_at":"2026-01-16T23:55:29.108Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","csharp","documentation","dotnet","markdown"],"created_at":"2026-01-17T00:24:19.168Z","updated_at":"2026-01-17T00:24:19.224Z","avatar_url":"https://github.com/ap0llo.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MdDocs\n\n## Overview\n\n[![Build Status](https://dev.azure.com/ap0llo/OSS/_apis/build/status/mddocs?branchName=master)](https://dev.azure.com/ap0llo/OSS/_build/latest?definitionId=11\u0026branchName=master)\n[![Renovate](https://img.shields.io/badge/Renovate-enabled-brightgreen)](https://renovatebot.com/)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n\n| Package                   | NuGet.org                                                                                                                      | MyGet                                                                                                                                                                               |\n|---------------------------|--------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `Grynwald.MdDocs`         | [![NuGet](https://img.shields.io/nuget/v/Grynwald.MdDocs.svg)](https://www.nuget.org/packages/Grynwald.MdDocs)                 | [![MyGet](https://img.shields.io/myget/ap0llo-mddocs/vpre/Grynwald.MdDocs.svg?label=myget)](https://www.myget.org/feed/ap0llo-mddocs/package/nuget/Grynwald.MdDocs)                 |\n| `Grynwald.MdDocs.MSBuild` | [![NuGet](https://img.shields.io/nuget/v/Grynwald.MdDocs.MSBuild.svg)](https://www.nuget.org/packages/Grynwald.MdDocs.MSBuild) | [![MyGet](https://img.shields.io/myget/ap0llo-mddocs/vpre/Grynwald.MdDocs.MSBuild.svg?label=myget)](https://www.myget.org/feed/ap0llo-mddocs/package/nuget/Grynwald.MdDocs.MSBuild) |\n\n*MdDocs* is a tool to generate documentation in the form of Markdown documents.\nIt currently supports:\n\n- Generating API reference from a .NET assembly and the corresponding XML documentation file\n- Generating command line help for projects that use the [CommandLineParser package](https://www.nuget.org/packages/CommandLineParser/) for parsing\n  \nFor an example of what the output looks like, have a look at the [demoprojects](docs/demoprojects) directory.\n\n## Documentation\n\nFor documentation on installation and usage, please refer to the\ncorresponding sub-pages:\n\n- [MdDocs .NET CLI Tool](./docs/net-cli-tool.md)\n- [MdDocs MSBuild Integration](./docs/msbuild-integration.md)\n- [Configuration](./docs/configuration/README.md)\n\n## Building from source\n\nℹ This repository uses git submodules. Use `git clone --recursive` to check out submodules as well.\n\nBuilding MdDocs from source requires the .NET 7 SDK (at lease version 7.0.101 as specified in [global.json](./global.json)) and uses [Cake](https://cakebuild.net/) for the build.\n\nTo run tests, the .NET 6 SDK and a installation of Visual Studio 2022 is requried as well.\n(this only applies to the `MdDocs.MSBuild.IntegrationTest` project, all other test project should be executable with only the .NET 7 SDK).\n\nTo execute the default task, run\n\n```ps1\n.\\build.ps1\n```\n\nThis will build the project, run all tests and pack the NuGet package.\n\n\n## Issues\n\nIf you run into any issues or if you are missing a feature, feel free to open an [issue](https://github.com/ap0llo/mddocs/issues).\n\nI'm also using issues as a backlog of things that come into my mind or things I plan to implement, so don't be surprised if many issues were created by me without anyone else being involved in the discussion.\n\n## Acknowledgments\n\n*MdDocs* was made possible through a number of libraries (aside from\n.NET Core and .NET Standard). Thanks to all the people contribution to these projects:\n\n- Parts of this program are based on code from the [NuDoq project](https://github.com/kzu/NuDoq/),\n  licensed under the Apache License 2.0.\n  See [`XmlDocsReader.cs`](src/MdDoc/Model/XmlDocs/XmlDocsReader.cs) for details\n- [Mono.Cecil](https://github.com/jbevain/cecil/)\n- [CommandLineParser](https://github.com/gsscoder/commandline)\n- [Nerdbank.GitVersioning](https://github.com/AArnott/Nerdbank.GitVersioning/)\n- [Microsoft.Extensions.Logging](https://github.com/aspnet/Extensions)\n- [Microsoft.Extensions.Configuration](https://github.com/aspnet/Extensions)\n- [Microsoft.DotNet.Analyzers.Compatibility](https://github.com/dotnet/platform-compat)\n- [xUnit](http://xunit.github.io/)\n- [Xunit.Combinatorial](https://github.com/AArnott/Xunit.Combinatorial)\n- [Moq](https://github.com/moq/moq4)\n- [ApprovalTests](https://github.com/approvals/ApprovalTests.Net)\n- [Microsoft.CodeAnalysis.CSharp](https://github.com/dotnet/roslyn)\n- [Coverlet](https://github.com/tonerdo/coverlet)\n- [SourceLink](https://github.com/dotnet/sourcelink)\n- [NuGet](https://github.com/NuGet/NuGet.Client)\n- [Newtonsoft.Json](https://www.newtonsoft.com/json)\n- [Cake](https://cakebuild.net/)\n- [Cake.BuildSystems.Module](https://github.com/cake-contrib/Cake.BuildSystems.Module)\n- [Verify](https://github.com/VerifyTests/Verify)\n- [nugetizer](https://www.clarius.org/nugetizer/)\n- [MSBuildStructuredLog](https://github.com/KirillOsenkov/MSBuildStructuredLog)\n\n## Versioning and Branching\n\nThe version of the library is automatically derived from git and the information in `version.json` using [Nerdbank.GitVersioning](https://github.com/dotnet/Nerdbank.GitVersioning):\n\n- The master branch  always contains the latest version. Packages produced from master are always marked as pre-release versions (using the `-pre` suffix).\n- Stable versions are built from release branches. Build from release branches will have no `-pre` suffix\n- Builds from any other branch will have both the `-pre` prerelease tag and the git commit hash included in the version string\n\nTo create a new release branch use the [`nbgv` tool](https://www.nuget.org/packages/nbgv/):\n\n```ps1\ndotnet tool install --global nbgv\nnbgv prepare-release\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fap0llo%2Fmddocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fap0llo%2Fmddocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fap0llo%2Fmddocs/lists"}