Modo: Mojo documentation generator -- `mojo doc` JSON to Markdown for SSGs

I've released Modo, a documentation generator for Mojo, written in Go. Modo generates Markdown files from mojo doc's JSON output. These files can be used to publish your API docs using a static site generator (SSG) e.g. on GitHub Pages. Currently, the only SSG fully supported is mdBook. This example site shows the Mojo standard library, processed with Modo and mdBook, and published on GitHab Pages. Any feedback on the Modo DocGen is highly appreciated! In case you spot any information that is provided in Modular's API docs but not on the example site, please let me know! https://github.com/mlange-42/modo
4 Replies
Darkmatter
Darkmatter2w ago
As a warning, that output format is unstable.
mlange-42
mlange-42OP2w ago
Thanks, I've read that already. Currently, changes should be easy to refactor in.
ModularBot
ModularBot2w ago
Congrats @mlange-42, you just advanced to level 1!
mlange-42
mlange-42OP2w ago
Added a daily CI workflow on stable and nightly stdlib to make sure to get noticed on breakage.

Did you find this page helpful?