MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust

This page summarizes the projects mentioned and recommended in the original post on news.ycombinator.com

Our great sponsors
  • WorkOS - The modern API for authentication & user identity.
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • LearnThisRepo.com - Learn 300+ open source libraries for free using AI.
  • 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

  • astro

    The web framework for content-driven websites. ⭐️ Star to support our work!

    I haven't seen the newcomer Starlight[1] being mentioned, so just throwing that out there as well. It's by the wonderful folks who created Astro[2] and my own limited usage of it has been great!

    [1]: https://starlight.astro.build/

    [2]: https://astro.build/

  • WorkOS

    The modern API for authentication & user identity. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  • hugo-book

    Hugo documentation theme as simple as plain book

    I use hugo with the book theme (https://github.com/alex-shpak/hugo-book). It takes a bit of getting used to (if you're not familiar with hugo) but after that it's pretty good with all the flexibility that hugo provides for shortcodes, etc. The katex support is good (looks like mdBook uses mathjax) and deploying just becomes a push/rsync.

  • Docusaurus

    Easy to maintain open source documentation websites.

    I am a long time Jekyll user and I still thing it's a great tool for blogs, but by far the best SSG for documentation websites I have found is Docusaurus. (https://docusaurus.io/)

    I resisted trying it for the longest time because I didn't want a JavaScript based tool, but I am glad I caved. It's so easy to get started, crazy fast, and the sites are absolutely beautiful out of the box yet easy to customize. The mdx support is awesome too.

  • mkdocs-material

    Documentation that simply works

    Wow, what is up with the material mkdocs theme (https://squidfunk.github.io/mkdocs-material/)? That's an extremely spiffy landing page, especially given that it's for a theme designed for a totally separate piece of software.

  • nextra

    Simple, powerful and flexible site generation framework with everything you love from Next.js.

  • KeenWrite

    Free, open-source, cross-platform desktop Markdown text editor with live preview, string interpolation, and math.

    I wrote KeenWrite, a free and open-source cross-platform tool, to create Markdown-based books. KeenWrite calls out to ConTeXt to typeset the documents and uses my KeenType fork for typesetting math while in preview mode. KeenWrite can generate PDF files from the command-line.

    * https://github.com/DaveJarvis/keenwrite

    For example:

        java -jar keenwrite.jar \

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  • til

    Things I learn/discover on daily basis. (by mraza007)

  • mdbook-graphviz

  • mdbook-confluence

  • honkit

    :book: HonKit is building beautiful books using Markdown - Fork of GitBook

    Since I see a few people in these comments mourning the general dive that gitbook has taken over the last few years, you might like this, an actively-maintained fork of gitbook as it was before it got bad:

    https://github.com/honkit/honkit

  • ark

    A static website generator for people who enjoy the simpler things in life. (by dmulholl)

    Md book is great! We created a Nim version to support content written with nimib (a framework to publish html pages with Nim code and its results) and it has been very useful! https://pietroppeter.github.io/nimibook/index.html

    As people are sharing other SSG (I think material for MkDocs is the absolute best for documentation sites), let me share a relatively unknown one that I find very interesting: https://github.com/dmulholl/ark

    I have as next project to try and port this ark to Nim/nimib (and ideally nimibook should be refactored to use it).

  • mdbook-kroki-preprocessor

    Render Kroki diagrams from files or code blocks in mdbook

  • kroki

    Creates diagrams from textual descriptions!

  • MkDocs

    Project documentation with Markdown.

  • Jekyll

    :globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby

  • obsidian-export

    Rust library and CLI to export an Obsidian vault to regular Markdown

    Found: https://github.com/zoni/obsidian-export but hope this can be part of a single solution.

  • obsidian-github-publisher

    Github Publisher helps you to publish your notes on a preconfigured GitHub repository from your Obsidian Vault, for free, and more!

    MkDocs with Obsidian Mkdocs? https://obsidian-publisher.netlify.app

  • sphinx

    The Sphinx documentation generator

    Notable mentions to [Sphinx](https://www.sphinx-doc.org/). It's workflow is more tuned to the "book" format rather than the blog, forum or thread format.

  • elegant-cli

    :purple_heart: Build SEO-friendly websites, super fast full-stack web applications, and much more with Elegant. Built with Next.js, Tailwind CSS, Outstatic, and more.

    I have used a number of different solutions over the years for simple documentation. Started with Wordpress, ended up on Docusaurus.

    Docusaurus is an amazing tool for startups, but it started to show its weaknesses as tried to scale it.

    Our project requirements needed something more, so I ended up forking Docusaurus and started working on my own solution.

    Check it out, I’d love to hear what everyone thinks! :)

    https://github.com/elegantframework/elegant-cli

    https://www.elegantframework.com/docs/installation

  • retype

    Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files.

  • LearnThisRepo.com

    Learn 300+ open source libraries for free using AI. LearnThisRepo lets you learn 300+ open source repos including Postgres, Langchain, VS Code, and more by chatting with them using AI!

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts