MkDocs
mdBook


MkDocs | mdBook | |
---|---|---|
118 | 106 | |
19,841 | 18,970 | |
1.1% | 1.7% | |
7.9 | 8.5 | |
3 months ago | 3 days ago | |
Python | Rust | |
BSD 2-clause "Simplified" License | Mozilla Public License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
MkDocs
-
How to Create and Publish a Python Package on PyPI 🐍
The original mkdocs uses a Python package for its installer, so you can just pip install mkdocs, mkdocs new ., and then mkdocs build to convert markdown files into HTML.
-
Docusaurus – Build optimized websites quickly, focus on your content
If you don't like to run javascript outside of a browser, MkDocs is a great Python-based alternative: https://www.mkdocs.org/
-
Why I Prefer RST to Markdown
I like Markdown because it's simple and doesn't give me that many headaches.
You know what I don't like? HTML, for user submitted content in particular. The mess I've seen, after someone opted for using HTML for messages in a system, because that's what JS based editors were available for at the time. Endless need to work against XSS, with more and more incremental updates needed to the sanitization logic, some of which broke the presentation of the data in the DB.
Never again. Markdown, BBCode, anything but that.
As for docs? Currently just some Markdown, because that's what GitHub, GitLab, Gitea and others all know how to render.
Maybe something like https://www.mkdocs.org/ for the more standalone use cases.
-
Why Docs-as-Code is the Key to Better Software Documentation
Developing the documentation website using an open-source static site generator like Sphinx or MkDocs to build the files locally through the command line, rather than using a commercial program.
- I am stepping down from MkDocs
-
Alternatives to Docusaurus for product documentation
MkDocs is BSD-2-Clause licensed and has a vibrant community; GitHub Discussion is used for questions and high-level discussion, while the Gitter/Matrix chat room is used to discuss less complex topics. These communities provide essential resources and support.
- Ask HN: Tips to get started on my own server
-
Enhance Your Project Quality with These Top Python Libraries
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.
-
Top 5 Open-Source Documentation Development Platforms of 2024
MkDocs is a popular static site generator designed explicitly for building project documentation. Its minimalist approach, flexibility, and ease of use have made it a favorite among developers and ideal for non-technical users.
mdBook
-
Procrastination and Perfectionism - FAV0 Weekly #022
mdBook - Create Books with Markdown in Rust
- 拖延与完美主义 - FAV0周刊#022
-
MdBook – a command line tool to create books with Markdown
Biggest downside of this tool is inability to render PDF or ePub[1]. This is why we recently switched to Quarto[2]. Typst is also a good alternative, already mentioned in other comments.
[1] https://github.com/rust-lang/mdBook/issues/815
[2] https://quarto.org/
-
Why I Prefer RST to Markdown
I think a good example is all of the wonderful documentation that's been created with mdBook.
Heck, the Rust book was written with it, and they also made a print edition, so maybe markdown is enough even for that.
https://github.com/rust-lang/mdBook
- Everything Curl
- Doks – Build a Docs Site
-
Ask HN: How do you organize software documentation at work?
I'm responsible for a number of Java products. I try to provide high-quality Javadoc for all public library interfaces, library user's guides where appropriate, and development guides for applications. The latter two take the form of MDBook documents (https://rust-lang.github.io/mdBook/), with the document source living in the GitHub repo so that it's tied to the particular software release in a natural way.
-
Outline: Self hostable, realtime, Markdown compatible knowledge base
My org has used mdBook: https://rust-lang.github.io/mdBook/ (That link is itself a rendered mdBook, so that'll give you an idea of the feature set.)
(While it's definitely a Rust "thing", if you just have a set of .md files, all you need is a "SUMMARY.md" (which contains the ToC) and a small config file; i.e., you don't have to have any Rust code to use it, and it works fine without. We document a large, mostly non-Rust codebase with it.)
-
Ask HN: Best tools for self-authoring books in 2023?
If you want the lowest friction, open source, easily extensible Markdown to Web, Kindle, PDF, etc. tool, highly recommend mdBook: https://github.com/rust-lang/mdBook it’s written in Rust, but you don’t have to know any Rust to use it. And then wing is all CSS; for which there are many good (free) themes.
- Early performance results from the prototype CHERI ARM Morello microarchitecture
What are some alternatives?
sphinx - The Sphinx documentation generator
gitbook - The open source frontend for GitBook doc sites
pdoc - API Documentation for Python Projects
Docusaurus - Easy to maintain open source documentation websites.
DocFX - Static site generator for .NET API documentation.
notty - A new kind of terminal
Hugo - The world’s fastest framework for building websites.
rubigo
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
iota - A terminal-based text editor written in Rust
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js

