News for hackers. Stuff that matters.
Re:MdBook – Create book from Markdown files. Like Gitbook bu... by bccdee on Thursday June 29, 2023 @11:23PM (#36530149)
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.
Re:MdBook – Create book from Markdown files. Like Gitbook bu... by jonasdoesthings on Friday June 30, 2023 @01:36AM (#36530906)
mkdocs-materials is underselling itself as only a theme imo. It bundles a lot of value that mkdocs is missing out of the box as plugins and tweaks, like a good client-side search, page tags, or easy support for a lot of markdown extensions (e.g. code syntax highlighting, admonitions/callouts).

From my personal experience mkdocs+mkdocs-material is like GNU+Linux.

Re:MdBook – Create book from Markdown files. Like Gitbook bu... by d4rkp4ttern on Friday June 30, 2023 @07:45AM (#36533209)
At least for Python documentation, this plus mkdocstrings is great.
Re:MdBook – Create book from Markdown files. Like Gitbook bu... by d4rkp4ttern on Friday June 30, 2023 @07:47AM (#36533220)
Check out the Pydantic docs pages - they use Mkdocs-material

https://docs.pydantic.dev/latest/