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 | antora.org |
Details $ | - |
Release Date | - |
Categories |
|
---|---|
Website | mkdocs.org |
Details $ | |
Release Date | 2014-10-29 |
Based on our record, Antora seems to be a lot more popular than MkDocs. While we know about 21 links to Antora, we've tracked only 2 mentions of MkDocs. 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.
You have also AsciiDoctor ( https://asciidoctor.org/ ) which is alive and well. I am using it for technical CS documentation internally, but only for single page documents. I did not try to deploy their whole multi-document setup called Antora ( https://antora.org/ ). - Source: Hacker News / 2 months ago
Well scaffolding an extension also generates a docs module wich leverages Antora, and with a minimal effort, we can produce a nice and clean documentation. - Source: dev.to / 5 months ago
AsciiDoc has a bit more features compared to Markdown which allows for a richer presentation of the docs. Biggest difference is that Linode has the docs in a separate repository. Not sure if it is a limitation of their toolchain or a deliberate decision. Antora allows you to have the project documentation in the actual project repositories. It then pulls the docs from all the different repos together to build the... - Source: Hacker News / 9 months ago
I've been pushing for Antora everywhere I go. It allows you to keep text-based (AsciiDoc, similar to markdown but an actual standard) documentation with your repositories and from that build a central documentation portal site. Source: 12 months ago
We use AsciiDoc for our technical documentation, and it's great. Last year we moved from AsciiDoctor to Antora [1] and I can't recommend it enough. [1] https://antora.org/. - Source: Hacker News / about 1 year ago
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: 12 months 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
Docusaurus - Easy to maintain open source documentation websites
GitBook - Modern Publishing, Simply taking your books from ideas to finished, polished books.
ReadTheDocs - Spend your time on writing high quality documentation, not on the tools to make your documentation work.
Doxygen - Generate documentation from source code
Asciidoctor - In the spirit of free software, everyone is encouraged to help improve this project.
Daux.io - Daux.io is a documentation generator that uses a simple folder structure and Markdown files to...