mdBook
MkDocs
Our great sponsors
mdBook | MkDocs | |
---|---|---|
100 | 111 | |
16,378 | 18,123 | |
2.7% | 1.8% | |
8.7 | 9.0 | |
9 days ago | 3 days 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
- 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.
- FLaNK Stack for 4th of July
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
- Effective Rust
-
is it possible to read books in vim?
If you are interested to draw something I also suggest you to use mdbook
- Super unpopular opinion incoming.
MkDocs
- 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.
-
5 Best Static Site Generators in Python
MkDocs is a popular static site generator specifically designed for project documentation. It is built on Python's Markdown processing engine and comes with a clean and responsive default theme. MkDocs is easy to configure, and its simplicity makes it an excellent choice for quickly creating documentation for your projects.
-
Creating a knowledge base website for work, do I need a database or can it be only front end designed?
Take a look at https://www.mkdocs.org
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
MkDocs Publisher as an alternative for official Obsidian publish.
For last few months, I was developing a set of plugins for MkDocs, that allows you to use GitHub Pages or GitLab Pages as a cheaper alternative to official Obsidian publish. Story behind this tool started quite long time a go, when I was using Nikola (static site tool for blogging) and Obsidian as a post editor. When Nikola stopped working for me on Apple Silicon (due to some problems with one of Python library) I started to look for a new tool. I couldn't find anything good enough and just started to work on my own plugin. From the first idea to current implementation, I build 5 plugins packed as a single Python library. As for Obsidian part, project currently supports:
-
Site-wide Protest, Introducing leagueoflinux.org, and Poll for What to do Next with r/leagueoflinux
The site is built using MkDocs and themed with MkDocs-Material. Being markdown-based, porting over the webpages from the subreddit wiki was fairly painless, and on some pages I've already been able to extend their capabilities with in-line images, buttons and more modern special formatting tools.
-
Ask HN: What is the best product documentation you’ve ever seen?
Visual Studio App Center has excellent documentation: https://learn.microsoft.com/en-us/appcenter/distribution/cod.... It's comprehensive and well structured.
If you're looking for a system that looks as good, mkdocs (https://www.mkdocs.org/) with the mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/) can get you quite close!
-
Knowledge base system choice
I would also look at https://www.mkdocs.org for organising documentation esp if you are used to 'readthedocs' manuals.
What are some alternatives?
sphinx - The Sphinx documentation generator
pdoc - API Documentation for Python Projects
DocFX - Static site generator for .NET API documentation.
Hugo - The world’s fastest framework for building websites.
Docusaurus - Easy to maintain open source documentation websites.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Read the Docs - The source code that powers readthedocs.org
gitbook - 📝 Modern documentation format and toolchain using Git and Markdown
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
VuePress - 📝 Minimalistic Vue-powered static site generator
mkdocs-material - Documentation that simply works
Pycco - Literate-style documentation generator.