mdBook
MkDocs
mdBook | MkDocs | |
---|---|---|
112 | 125 | |
19,797 | 20,612 | |
1.5% | 1.4% | |
9.5 | 6.8 | |
10 days ago | 4 months ago | |
Rust | Python | |
Mozilla Public License 2.0 | BSD 2-clause "Simplified" License |
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.
mdBook
-
Publishing in Arabic, Hebrew, or Persian?
I personally use mdbook (and another home-made system) to build my own sites/books. here you can see examples of public mdbooks in various languages. You can also see them grouped by language.
-
Hacking with mdBook
mdBook is a Rust-based tool to create Web-based books from vanilla Markdown files. Although it is quite minimalistic, you will bump into it quite often in the wild. Most notably, the Rust Book uses it. I see it quite often in the Nix ecosystem, too.
-
Why I am Migrating From Zola Back to Hugo
I have a local site I use as a knowledge base, journal and scratchpad. I recently migrated it from mdBook to Hugo, using the Hextra theme. The result was so good that I started questioning my use of Zola as my primary static site generator.
- Ask HN: Static Site (not blog) Generator?
- Show HN: Rustdoc-style linking in mdBook (with the help of Rust-analyzer)
-
Show HN: Open-Source DocumentAI with Ollama
Nice work. Any plans to somehow integrate into mdbooks (https://rust-lang.github.io/mdBook/) ?
Or a general web user-interface?
-
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
MkDocs
-
How to Install and Use MkDocs: A Beginner's Guide
# Welcome to MkDocs For full documentation visit [mkdocs.org](https://www.mkdocs.org). ## Commands * `mkdocs new [dir-name]` - Create a new project. * `mkdocs serve` - Start the live-reloading docs server. * `mkdocs build` - Build the documentation site. * `mkdocs -h` - Print help message and exit. ## Project layout mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.
-
The Carpet feature that nobody will use
The documentation is built with MkDocs and hosted on GitHub Pages. You can browse the complete documentation at carpet.jerolba.com.
-
Why I am Migrating From Zola Back to Hugo
MkDocs
-
How to Migrate Technical Documentation: Tools, Checklist, and Tips
MkDocs is a static site generator designed specifically for project documentation and written in Python. It’s easy to set up, uses markdown for content, and features a number of themes, including the popular Material for MkDocs. MkDocs integrates well with Python-based workflows and CI/CD tools. It’s a great choice for Python developers and teams looking for simplicity and readability.
-
KiSSES: Keep Static Site Examples Simple
Because of my frustrations, I've released two example GitHub repositories for two popular static site generators: MkDocs and Sphinx. The goal with these repositories is to be focussed on a minimal project using the static site generator, that builds into a Read The Docs theme compatible website, and provide supporting tooling regarding formatting of the underlying formatting language. It also provides the tooling needed to deploy to GitHub Pages both from the command line and via GitHub Actions (both are powered by the ghp-import project).
-
Automating an Open Source Project with GitHub Actions
The documentation of the CLI is provided via a GitHub page as part of the repository. We are using MkDocs to generate the content, but I think most of the tools in that area are well integrated with GitHub and GitHub Actions.
-
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.
What are some alternatives?
gitbook - The open source frontend for GitBook doc sites
sphinx - The Sphinx documentation generator
rubigo
pdoc - API Documentation for Python Projects
Docusaurus - Easy to maintain open source documentation websites.
DocFX - Static site generator for .NET API documentation.