DNDocs (Dot Net Docs) is a free documentation hosting platform for .NET projects
There is not effortless way to create and host API documentation for .NET Core projects. Current tools requires to integrate with build and publishing process to maintain docs up-to-date
Insert following markdown into README.md file:
[](https://dndocs.com/?packageName={PackageName}&packageVersion={PackageVersion})
For example:
[](https://dndocs.com/?packageName=Microsoft.EntityFrameworkCore&packageVersion=8.0.3)
Result:
Docfx API explorer is hosted online.
You don't have any API Explorer for Your .NET project and want to host it in one minute -> use DNDocs
Looking on github C# repositories lots of them did not have any documentation online. To take a look on basic project structure and what methods are exposed we needed to open open each .cs file just to simply look what functions and methods are there. Also there was not any website that allows to just simply generate and host documentation for .NET Core project online.
Url to documentation can be shared in any form, for example:
- Put dndocs API Explorer URL to github project README
- Generate shields.io badge with Project API Explorer, for example:
(look below in this document for 'shields.io badge informations' to see how to generate exactly same badge)
- Or anything other
shields.io badge informations:
Badge on shields.io can be generated with any parameters
but as an example above I generated badge with following parameters:
badgeContent: API Docs-DNDocs-190088
logo: readme
logoColor: white
Ready to copy-paste markdown badge (only replace 'WWWdndocsCOM/API_EXPLORER_LINK' with valid url):
[](WWWdndocsCOM/API_EXPLORER_LINK)
If You find any bugs or unexpected behaviour please report this in 'issues' tab in this repository
https://docs.dndocs.com/system/projects/29 https://docs.dndocs.com/system/projects/28 https://docs.dndocs.com/system/projects/27 https://docs.dndocs.com/system/projects/26 https://docs.dndocs.com/system/projects/25 [etc.]