MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.
Categories |
|
---|---|
Website | mkdocs.org |
Details $ | |
Release Date | 2014-10-29 |
Categories |
|
---|---|
Website | dotnet.github.io |
Details $ | |
Release Date | - |
Based on our record, DocFX should be more popular than MkDocs. It has been mentiond 7 times since March 2021. We are tracking product recommendations and mentions on various public social media platforms and blogs. They can help you identify which product is more popular and what people think of it.
I'm a software engineer, and before getting my rM2, I kept all of my notes in Markdown format. They're under source control (git), and I use mkdocs to build them into a static website. I have a CI pipeline set up so that whenever I push changes to my notes to GitHub/Gitlab/Sourcehut, they are automatically built and published to my site. Source: about 1 year ago
Starlette is a web framework developed by the author of Django REST Framework (DRF), Tom Christie. DRF is such a solid project. Sharing the same creator bolstered my confidence that Starlette will be a well designed piece of software. - Source: dev.to / about 3 years ago
This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool? https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html https://dotnet.github.io/docfx/ I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated... - Source: Hacker News / 4 months ago
Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/. Source: about 2 years ago
We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead. Source: over 2 years ago
I use docfx from microsoft to generate documentation for all my oss libraries. Source: over 2 years ago
My best guess would be that there's a CI/CD pipeline in GitHub that utilizes DocFX to convert the Markdown files to HTML. The constructed HTML files are then placed in an Azure Storage account that configured for Static Website Hosting combined with Azure CDN. Source: over 2 years ago
Doxygen - Generate documentation from source code
GitBook - Modern Publishing, Simply taking your books from ideas to finished, polished books.
Docsify.js - A magical documentation site generator.
Docusaurus - Easy to maintain open source documentation websites
Daux.io - Daux.io is a documentation generator that uses a simple folder structure and Markdown files to...
Natural Docs - Natural Docs is an open-source documentation generator for multiple programming languages.