Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

MdBook – A command line tool to create books with Markdown

rust-lang.github.io

Post reply on HN
Print view View original

1–10 of 123 posts

Re: MdBook – A command line tool to create books with Markdown

#2

Post by eddythompson80 »

I recently started exploring, and slowly migrating, to .mdx over .md for content. So far it’s been a breath of fresh air tbh. My biggest problem of markdown was the specific flavor I happen to be using and the type of cliffs I’d run into, then how to extend them.

I’m extremely satisfied with 80-90% of the standard Gitbook markdown flavor. Then every now and then I really wanna make a complicated table, or a code block highlighting few lines while maintaining syntax highlighting, or an interactive slider, or a formula calculator that’s built-in the documentation instead of a complicated function, or a particular graph/chart etc. I don’t know how something like mdx would work for a large team (ever tried to clone Microsoft’s doc repo?) but at least for my own stuff, it seems like a definite improvement.

Re: MdBook – A command line tool to create books with Markdown

#3

Post by FractalHQ »

eddythompson80 wrote: post #2

I recently started exploring, and slowly migrating, to .mdx over .md for content. So far it’s been a breath of fresh air tbh. My biggest problem of markdown was the specific flavor I happen to be using and the type of cliffs I’d run into, then how to extend them. I’m extremely satisfied with 80-90% of the standard Gitbook markdown flavor. Then every now and then I really wanna make a complicated table, or a code bloc…

I couldn’t agree more. Mdsvex was life changing when I discovered it: https://mdsvex.com

Re: MdBook – A command line tool to create books with Markdown

#4

Post by harry8 »

Way to bury the lede.

Like gitbook but Free.

The rust zealotry put me right off fwiw. As it does my interest in the language itself. I wish those guys would calm down they're totally detracting from whatever the strengths of rust are with that nonsense.

edit: gitbook pricing for comparison https://www.gitbook.com/pricing

Re: MdBook – A command line tool to create books with Markdown

#5

Post by rmrfchik »

Started using mdBook couple days ago for documenting small project. This is exactly what I need: small static pages generator. Tried HUGO, but it seems so huge and bloated comparing to mdBook. Now I edit doc with Obsidian/VIM, push to Gitea and in minute get public documentation.

Re: MdBook – A command line tool to create books with Markdown

#6

Post by bluejekyll »

rmrfchik wrote: post #5

Started using mdBook couple days ago for documenting small project. This is exactly what I need: small static pages generator. Tried HUGO, but it seems so huge and bloated comparing to mdBook. Now I edit doc with Obsidian/VIM, push to Gitea and in minute get public documentation.

I’ve started using a plantuml extension for it recently, helps embed architectural diagrams in the docs.

Re: MdBook – A command line tool to create books with Markdown

#8

Post by xcdzvyn »

harry8 wrote: post #4

Way to bury the lede. Like gitbook but Free. The rust zealotry put me right off fwiw. As it does my interest in the language itself. I wish those guys would calm down they're totally detracting from whatever the strengths of rust are with that nonsense. edit: gitbook pricing for comparison https://www.gitbook.com/pricing

I think they'd be best served not using the words "Rust" nor "GitBook" in their marketing, given it lacks most of the features of GitBook (that's probably why it isn't free!); mdBook appears to just be a static site generator.

Re: MdBook – A command line tool to create books with Markdown

#9

Post by lwhsiao »

Was using mdbook for a lot of projects, but these days, I feel like material for mkdocs just has so much more built in that makes it nice to use.

One example, I really like the page TOC on the right side that is notably absent from mdbook, where it seems the standard to set up SUMMARY very detailed and break what could've been a single page into many different files.

Post reply on HN