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
- Open https://dndocs.com and signin with Github account
- Create a project with Nuget Package Name
- Click save button
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
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.
Only thing needed is nuget package name.
Adventages of using DNDocs:
- DNDocs generates sitemap.xml
- Very easy configuration - only nuget package needed
- No need to maintain code for documents generation and publishing
- Automatic rebuild MD docs from github
- Automatic rebuild Nuget Pakcages to latests
- No actions needed after creating docs - all upgrades are autmated
- Supports multiple Docfx templates (darkfx, discordfx, docfx-minimal-main, material, unit)
- Basic Versioning support
To host API explorer without registering on dndocs, please create a new pull request.
- Edit 'projects.md' file and add a new row in the table
- In commit message please add following informations:
Project Name: project_name
DNDocs Url Prefix: url_prefix
Github Url: github_url
Description: description
Nuget Package Name: package_name (Install-Package 'package_name')
(if project does not have nuget package please add link to binary files like line below)
Dll Xml files: <url to .dll and .xml files)
For Example:
Project Name: Arctium Crypto Library
DNDocs Url Prefix: arctium
Github Url: https://github.com/NeuroXiq/Arctium
Description: Arctium is a simple crypto library. It provides various cryptographic functions, ciphers, connection protocols
Nuget Package Name: Arctium.Shared
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