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.
No reStructuredText videos yet. You could help us improve this page by suggesting one.
Based on our record, reStructuredText should be more popular than MkDocs. It has been mentiond 9 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
Markup language: Markup language is used to write documents in a way that distinguishes them from plain text. Most SSGs utilize lightweight markup languages, such as Markdown. However, alternatives like AsciiDoc, Textile, and ReStructuredText are also used. These lightweight languages simplify content creation and are converted into HTML during the site generation process. - Source: dev.to / 7 months ago
Uses Sphinx, reStructuredText And the sphinx-rtd-theme for writing, building And rendering the documentation. Source: 8 months ago
If we're dreaming, ReStructed Text support. Source: about 1 year ago
You can always switch to rst¹ and sphinx² to produce html/pdf came join the dark side, we have tables³ :) 1. https://docutils.sourceforge.io/rst.html. - Source: Hacker News / over 1 year ago
ReStrutucturedText is still useful to look at for inspiration here. It had the concepts of extensible metadata ("field lists"), spans ("interpreted text"), and blocks ("directives"). Including things like applying metadata to spans (using essentially Footnotes to provide field lists to interpreted text sections, like but better than Markdown's reference style for hyperlinks which almost no one uses but were much... - Source: Hacker News / almost 2 years ago
Doxygen - Generate documentation from source code
Asciidoctor - In the spirit of free software, everyone is encouraged to help improve this project.
GitBook - Modern Publishing, Simply taking your books from ideas to finished, polished books.
Markdown by DaringFireball - Text-to-HTML conversion tool/syntax for web writers, by John Gruber
Docusaurus - Easy to maintain open source documentation websites
Org mode - Org: an Emacs Mode for Notes, Planning, and Authoring