News for hackers. Stuff that matters.
Re:Markdoc: Stripe's Markdown-based authoring framework by squidfunk on Sunday May 15, 2022 @12:44AM (#31385330)
Author of Material for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.

[1]: https://mkdocstrings.github.io/

[2]: https://github.com/mkdocstrings/python

[3]: https://github.com/mkdocstrings/crystal

Re:Markdoc: Stripe's Markdown-based authoring framework by d4rkp4ttern on Tuesday May 17, 2022 @08:09AM (#31409290)
Another important requirement for me is support for Math notation in docstrings and elsewhere. Looks like MkDocs supports mathjax?

https://squidfunk.github.io/mkdocs-material/reference/mathja...

Re:Markdoc: Stripe's Markdown-based authoring framework by squidfunk on Tuesday May 17, 2022 @08:56AM (#31409822)
Jup, MathJax is supported with minimal setup: https://squidfunk.github.io/mkdocs-material/reference/mathja...
Re:Markdoc: Stripe's Markdown-based authoring framework by d4rkp4ttern on Tuesday May 17, 2022 @09:42AM (#31410468)
Thanks. The MkDocs docs looks great. Would you be able to point to a sample (python) repo that has various configs etc that I can tweak? When starting with Sphinx + ReadTheDocs this was the most time consuming part , it took me several hours hunting down various docs and examples.
Re:Markdoc: Stripe's Markdown-based authoring framework by squidfunk on Tuesday May 17, 2022 @10:24AM (#31411154)
I recommend checking the list of OpenSource projects that use Material for MkDocs [1], for example FastAPI [2]. Alternatively, you can clone the Material for MkDocs repository, as the docs are built with itself.

[1] https://github.com/squidfunk/mkdocs-material#trusted-by-

[2] https://github.com/tiangolo/fastapi

Re:Markdoc: Stripe's Markdown-based authoring framework by d4rkp4ttern on Tuesday May 17, 2022 @08:07AM (#31409259)
This is great, thank you.