Hacker GitHub

← All repos

rust-lang/mdBook

View on GitHub ↗ ★ 22,258 Rust

Create book from markdown files. Like Gitbook but implemented in Rust

53 mentions on Hacker News by 35 people: 1 story, 52 comments · first 2019-02-05 · latest 2025-12-23

Mentions per year 53 mentions · busiest year 2020 (21)
20082026
AllStoriesComments NewestTopOldest
  1. …And Typst (or LaTeX for more conservative folks) for the offline documentation/articles/books. [1] https://github.com/rust-lang/mdBook/issues/815 [2] https://quarto.org/
    comment by xvilka · 2025-12-23 · in Plugins case study: mdBook preprocessors
  2. …project idea like mdBook[1] but also you to insert quizzes/examples alongside static notes [1]: https://github.com/rust-lang/mdBook
    comment by maartin0 · 2025-11-27 · in Linux Kernel Explorer
  3. …to that for now. I don't need that much semantic meaning in the text. Something like mdbook ( https://github.com/rust-lang/mdBook ) is more than enough for my needs, compared to shipping docs in once again, gag DOCX files and PDFs. Good…
    comment by KronisLV · 2025-11-23 · in Markdown is holding you back
  4. …clear what the final directory structure would be. For Markdown there's https://docusaurus.io/ and https://github.com/rust-lang/mdBook Eleventy is another option for various templating languages: https://www.11ty.dev/ See also these lists:…
    comment by solardev · 2025-05-06 · in Ask HN: Static Site (not blog) Generator?
  5. …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/
    comment by xvilka · 2024-11-11 · in MdBook – a command line tool to create books with Markdown
  6. …my limit but what is the difference between this and other "md compiler" projects (or ssr) like < https://github.com/rust-lang/mdBook >? Anyway this seems to work very well, so congrats!
    comment by emanuele-em · 2024-10-09 · in Otter Wiki: A minimalistic wiki powered by Python, Markdown and git
  7. …fancy to host it. This example shows a fairly short GitHub action to deploy to GitHub pages: https://github.com/rust-lang/mdBook/wiki/Automated-Deploymen...
    comment by paholg · 2024-07-31 · in I prefer rST to Markdown
  8. …a single readme file works well. They also have some nice instructions on automated deployments. https://github.com/rust-lang/mdBook
    comment by paholg · 2024-07-31 · in I prefer rST to Markdown
  9. …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
    comment by paholg · 2024-07-31 · in I prefer rST to Markdown
  10. …pdf+epub ( https://learnbyexample.github.io/customizing-pandoc/ ). For web version, I use mdbook ( https://github.com/rust-lang/mdBook ) mainly because it comes with user choosable themes and search by default. However, if I had to start…
    comment by asicsp · 2024-05-18 · in Ask HN: Best way for a Markdown based blog and eBook?
  11. mdBook https://github.com/rust-lang/mdBook
    comment by bean-weevil · 2024-04-29 · in Everything Curl
  12. And https://github.com/rust-lang/mdBook
    comment by ivanjermakov · 2024-03-05 · in Doks – Build a Docs Site
  13. …that readers can choose. [0] https://learnbyexample.github.io/customizing-pandoc/ [1] https://github.com/rust-lang/mdBook
    comment by asicsp · 2024-02-02 · in Pandoc
  14. looks like mdBook https://github.com/rust-lang/mdBook
    comment by emlos · 2023-12-07 · in Data Engineering Design Patterns
  15. Author of the book here — yes, I used Mdbook ( https://github.com/rust-lang/mdBook ), and the links strangely end with `.html. as you correctly updated. Initially, I wanted to change it but left it as it was.
    comment by articsputnik · 2023-12-07 · in Data Engineering Design Patterns
  16. …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 customising is all CSS; for…
    comment by nelsonic · 2023-10-10 · in Ask HN: Best tools for self-authoring books in 2023?
  17. Interesting enough there seems to be an open PR for that: https://github.com/rust-lang/mdBook/pull/1918
    comment by Ygg2 · 2023-06-30 · in MdBook – A command line tool to create books with Markdown
  18. …or Markdown, but community backends offer more perspective. An experimental epub backend exists. https://github.com/rust-lang/mdBook/wiki/Third-party-plugins A web search gives a public repository for this book, so it should be possible to…
    comment by idoubtit · 2023-06-15 · in Effective Rust (2021)
  19. Too late to edit, but thought of another option: https://github.com/rust-lang/mdBook Gitlab Pages + mdBook works well for more documentation or book-like sites. I could easily this working for certain types of project sites.
    comment by james-skemp · 2022-06-27 · in Ask HN: Where do you publish projects?
  20. …and mdbook to generate web version [1] [0] https://learnbyexample.github.io/customizing-pandoc/ [1] https://github.com/rust-lang/mdBook
    comment by asicsp · 2022-04-28 · in I earned $160k in passive income from writing non-fiction books
  21. …Joplin [1] to write and then exports everything in an mdbook [2]. [1]: https://joplinapp.org/ [2]: https://github.com/rust-lang/mdBook
    comment by sirodoht · 2022-04-03 · in Ask HN: What's the best platform for technical writing in 2022?
  22. …of mdBook to produce formats like PDF or ePub. So far it works well, amazing job! [1] https://github.com/rust-lang/mdBook/issues/88 [2] https://github.com/rust-lang/mdBook/issues/815
    comment by xvilka · 2022-01-24 · in Quarto: A scientific and technical publishing system built on Pandoc
  23. …option. A bit more general than just for docs, though they advertise it as a first class use case. https://github.com/rust-lang/mdBook
    comment by jacobmischka · 2021-11-18 · in Ask HN: What are you using for public documentation these days?
  24. I've been using mdBook: https://github.com/rust-lang/mdBook for a personal knowledge base in an ebook format and it's been a joy. Not Ruby, it's written in Rust instead. It's very easy to customize either via plugins with Rust or by…
    comment by canyonero · 2021-09-20 · in Ruby for eBook Publishing
  25. …is formatted using a program called mdBook, a tool in rust for converting markdown to HTML books: https://github.com/rust-lang/mdBook
    comment by lelandbatey · 2021-05-06 · in The Rustonomicon
  26. …ePub[1][2]. Compared to gitbooks from which we switched to mdBook it's a significant downgrade. [1] https://github.com/rust-lang/mdBook/issues/815 [2] https://github.com/rust-lang/mdBook/issues/88
    comment by xvilka · 2021-03-09 · in I self-published a paperback and eBook using LaTeX and Pandoc
  27. …Cargo Book: https://doc.rust-lang.org/cargo Which seems to be generated by https://github.com/rust-lang/mdBook Now, I don't see why "book" should seem so grand. Remember when reference books would come out as a "bible"? As for bounds
    comment by __s · 2020-11-17 · in The Rust Performance Book
  28. MdBook: https://github.com/rust-lang/mdBook
    comment by naim94a · 2020-11-03 · in Ask HN: Open-Source Alternatives to Gitbook
  29. mdBook! https://github.com/rust-lang/mdBook It can do LaTeX and code, and be updated in real time so those were real time notes! Some other examples * https://briantliao.com/interviewing-notes/ * https://briantliao.com/deep-learning-notes/…
    comment by georgeEsb · 2020-11-01 · in Distributed Systems Learning Notes
  30. Thanks, probably this issue? https://github.com/rust-lang/mdBook/issues/1304
    comment by asicsp · 2020-10-02 · in Show HN: Ruby One-Liners Cookbook
  31. …for 'Coal' and 'Navy' themes, because for other combinations I'm able to see them properly. [0] https://github.com/rust-lang/mdBook
    comment by asicsp · 2020-09-30 · in Show HN: Ruby One-Liners Cookbook
  32. …host it via GitHub pages or your own domain. [1] https://learnbyexample.github.io/py_resources/ [2] https://github.com/rust-lang/mdBook [3] https://www.getzola.org/documentation/getting-started/overvi...
    comment by asicsp · 2020-09-21 · in Free Learning Resources related to Web-Development
  33. Recently played with https://github.com/rust-lang/mdBook as well and was very impressed.
    comment by slow_donkey · 2020-08-15 · in MkDocs: Project Documentation with Markdown
  34. …equivalent of R's `bookdown`. I've switched out internal documentation over to it from `gitbook`. https://github.com/rust-lang/mdBook
    comment by thomascgalvin · 2020-08-13 · in The new Jupyter Book
  35. …think it is out of beta yet. Until then you could use issues for discussions. Or reddit may be? [1] https://github.com/rust-lang/mdBook
    comment by asicsp · 2020-07-31 · in Ask HN: Best way to publish a free book online?
  36. …references across chapters. [1] https://learnbyexample.github.io/tutorial/ebook-generation/c... [2] https://github.com/rust-lang/mdBook
    comment by asicsp · 2020-07-18 · in Show HN: JavaScript regexp eBook with hundreds of examples and exercises
  37. See also mdBook [0] for another alternative to Gitbook [0] https://github.com/rust-lang/mdBook
    comment by asicsp · 2020-06-27 · in HonKit: A Fork of GitBook
  38. …may not be a right fit, but it is an interesting take & might be good for a first-pass. mdbook ( https://github.com/rust-lang/mdBook ) uses elasticlunr ( http://elasticlunr.com/ ) as an inverted index and is generated statically. The same…
    comment by cetra3 · 2020-06-10 · in Writing a full-text search engine using Bloom filters (2013)
  39. I felt the same way so have switched completely to taking nodes using https://github.com/rust-lang/mdBook I back everything up in a private git repo and then use various plugins built on top of mdbook to get all the functionality I want: *…
    comment by dylanowen · 2020-05-30 · in Show HN: Obsidian – A knowledge base that works on local Markdown files
  40. https://github.com/rust-lang/mdBook
    comment by goodSyntax · 2020-05-19 · in Argon – a clean, responsive, modern template for Dokuwiki
  41. …search or go back to refer them? Have you considered porting this to a doc generator like mdBook( https://github.com/rust-lang/mdBook ).
    comment by ramshandilya · 2020-04-18 · in I've been writing TILs for 5 years
  42. …it can be a perfect solution for creating modern documents without the legacy churn. [1] https://github.com/rust-lang/mdBook/issues/815 [2] https://github.com/lise-henry/crowbook/ [3] https://github.com/crlf0710/tectonic/tree/oxidize
    comment by xvilka · 2020-04-13 · in mdBook – A utility to create modern online books from Markdown files
  43. Right in the beginning of readme! :) https://github.com/rust-lang/mdBook#what-does-it-look-like There is also a collection of mdbooks by other people https://github.com/softprops/awesome-mdbook And a shameless plug, I'm using mdbook to…
    comment by karlicoss · 2020-04-13 · in mdBook – A utility to create modern online books from Markdown files
  44. Is it still connecting to Google Fonts? Open Issue: Remove Google surveillance #847 https://github.com/rust-lang/mdBook/issues/847
    comment by atrilumen · 2020-04-13 · in mdBook – A utility to create modern online books from Markdown files
  45. ▲ 258
    mdBook – A utility to create modern online books from Markdown files
    story by karlicoss · 2020-04-13 · 41 comments
  46. mdbook ( https://github.com/rust-lang/mdBook ) is open source, and I think it's very similar to gitbook in functionality
    comment by karlicoss · 2020-03-17 · in Serverless eBook Using Gitbook, GitHub Pages, GitHub Actions, and Calibre
  47. I've been using https://github.com/rust-lang/mdBook with plugins: https://github.com/dylanowen/mdbook-graphviz the plugins are all done via stdio so any language works
    comment by dylanowen · 2020-02-17 · in Markdeep – plain text documents with diagrams, equations, and Markdown syntax
  48. Someone mentioned mdBook, that thing is written in Rust and is amazingly fast even for huge sites. https://github.com/rust-lang/mdBook
    comment by type0 · 2019-12-03 · in Tract: A Hugo theme for ambitious documentation projects
  49. I've been using [mdBook]( https://github.com/rust-lang/mdBook ) for my wiki/documentation needs lately. It's great, the directory structure is straightforward and even supports search (through lunr.js) out of the box.
    comment by gammaray · 2019-12-03 · in Tract: A Hugo theme for ambitious documentation projects
  50. …really need HTML in places you can do that inside your markdown to get the best of both worlds. [1] https://github.com/rust-lang/mdBook
    comment by Niksko · 2019-12-03 · in Tract: A Hugo theme for ambitious documentation projects