Top
Best
New

Posted by chmaynard 4 days ago

Plugins case study: mdBook preprocessors(eli.thegreenplace.net)
12 points | 2 comments
klodolph 1 hour ago
I already think that markdown is barely ok for writing documentation, and the experience of plugins in mdBook is why I tell people not to use it (edit: it = mdBook). The base flavor of mdBook is minimalistic. Maybe that’s a good thing, that you’re given a minimalistic markdown as a starting point? But if it’s minimalistic, then it’s certainly missing some things that I’d want to use in the documentation I write, and the experience of using plugins is, well, not very good.

My current recommendations are MkDocs (material theme), Jekyll, and Docusaurus. Hugo gets a qualified recommendation, and I only recommend mdBook for people who are doing Rust stuff.

denysvitali 38 minutes ago|
What is missing from markdown? mdbook also uses in some parts the GH flavored one, so you can create notes [1] and similar. On top of that, you can add support for Mermaid.

Personally, I don't think you need more than that for 90% of the documentation, but I'm happy to hear more about your use case.

[1]: https://github.com/orgs/community/discussions/16925