The latest articles on DEV Community by Marek Węglarz (@neuroxiq). https://dev.to/neuroxiq https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F1205420%2Fdada5f59-a86e-43af-9b8c-4ceefdc8bf92.jpeg https://dev.to/neuroxiq en Marek Węglarz Wed, 08 Nov 2023 23:12:46 +0000 https://dev.to/neuroxiq/dndocs-3k6g https://dev.to/neuroxiq/dndocs-3k6g <h2> Free online documentation hosting platform </h2> <p><a href="https://res.cloudinary.com/practicaldev/image/fetch/s--hcvlqfPK--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://github.com/NeuroXiq/DNDocs/assets/19374897/4a4f0d7b-4903-4b92-b82b-db6073d9ece4" class="article-body-image-wrapper"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--hcvlqfPK--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://github.com/NeuroXiq/DNDocs/assets/19374897/4a4f0d7b-4903-4b92-b82b-db6073d9ece4" alt="image" width="800" height="485"></a></p> <p><a href="https://github.com/NeuroXiq/DNDocs">DNDocs - Github</a><br> <a href="https://dndocs.com">DNDocs.com</a></p> <p>Some time ago I started to develop project for fun - DNDocs.<br> 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.</p> <p>Basically usage is as following:</p> <ol> <li>Open <a href="https://dndocs.com">https://dndocs.com</a> and signin with Github account</li> <li>Create a project with Nuget Package Name</li> <li>Rebuild Project</li> </ol> <p>Docfx API explorer is hosted online.</p> <h2> Motivation </h2> <p>Looking on github C# repositories lots of them did not have any documentation online. To take a look on basic project structure<br> and what methods are exposed we needed to open open each .cs file just to simply look what functions and methods are there.<br> Also there was not any website that allows to just simply generate and host documentation for .NET Core project online.</p> <h2> Solution: DNDocs </h2> <p>DNDocs allows to host API Explorer in one minute.</p> <p>Url to documentation can be shared in any form, for example:</p> <ol> <li>Put dndocs API Explorer URL to github project README </li> <li>Generate shields.io badge with Project API Explorer, for example: <a href="https://dndocs.com/d/arctium/api/Arctium.Standards.Connection.Tls.Tls13.API.Tls13ClientConfig.html"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--XfvnfewP--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://img.shields.io/badge/API%2520Docs-DNDocs-190088%3Flogo%3Dreadme%26logoColor%3Dwhite" alt="Static Badge" width="129" height="20"></a> <em>(look below in this document for 'shields.io badge informations' to see how to generate exactly same badge)</em> </li> <li>Or anything other</li> </ol> <p>If You have a small or medium size .NET Core project - try DNdocs! \<br> DNdocs can be used as a <em>default project documentation</em> or <em>temporary documentation</em> for projects that does not have any documentation yet. \</p> <p>any ideas for improvements are welcome.</p> documentation webdev dotnet docfx