mdBook-based builder

MarkdownDocs can also lay the docs out as an mdBook: search, dark mode, a sidebar that makes sense, M2 highlighted by mdbook-tsitter, maths with KaTeX.

mdBook "Graphs"

builds it, serves it locally and opens the browser, like viewHelp. The server goes away when M2 does.

The book layout

The docs are grouped the way you’d read them, not the way they’re stored: all methods of a function are chapters of that function’s page, and a package’s methods on someone else’s function (say degree of a graph) get a page in that package. mdDocs gives the plain one-page-per-node layout instead.

Your package as a website

writeMdBook("MyPackage", "docs", LinkedPackages => true)
writeBookFiles "docs/MyPackage"

mdbook build docs/MyPackage -d "$PWD/site/MyPackage"

Build every package’s book side by side so the links between them work, and site/ can go straight to GitHub Pages.

Needs mdBook; mdbook-tsitter and mdbook-katex are optional but recommended.