Free online documentation hosting platform
Some time ago I started to develop project for fun - DNDocs.
This website allows to host documentation for .NET Core projects using nuget packages for API Explorer and markdown files cloned from github repository. I tries to make hostin .NET API explorer as simple as possible, so it is possible to host docs in one minute.
Basically usage is as following:
- Open https://dndocs.com and signin with Github account
- Create a project with Nuget Package Name
- Rebuild Project
Docfx API explorer is hosted online.
Motivation
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.
Solution: DNDocs
DNDocs allows to host API Explorer in one minute.
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
If You have a small or medium size .NET Core project - try DNdocs! \
DNdocs can be used as a default project documentation or temporary documentation for projects that does not have any documentation yet. \
any ideas for improvements are welcome.
Top comments (0)