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/modo14 Replies
As a warning, that output format is unstable.
Thanks, I've read that already. Currently, changes should be easy to refactor in.
Congrats @mlange-42, you just advanced to level 1!
Added a daily CI workflow on stable and nightly stdlib to make sure to get noticed on breakage.
https://aur.archlinux.org/packages/modo
Added to aur
1.5 weeks after the initial release, Modo has grown in features:
* Generates Mojo🔥 API docs for Hugo, mdBook or just plain Markdown.
* Provides a simple syntax for code cross-references.
* Optionally structures API docs according to package re-exports.
* Optionally extracts doc-tests for
mojo test from code blocks.
* Customizable output through user templates.
Since yesterday, it is also on PyPI and installable with pip install pymodo.
Modo🧯 now can extract doc-tests also from additional Markdown files. :mojonightly:Hey @mlange-42, any interest in talking about this project at our upcoming community meeting on February 3rd?
@Caroline hm, not sure. will see whether I find the time to prepare an appropriate presentation. what's the latest date you need to know it?
By Friday afternoon would be great
ok, i will inform you sufficiently early.
@Caroline At which time (zone) is it on Monday?
It's at 10 AM Pacific Time
7pm for me, that works. thanks!
Hi @Caroline, I can give the presentation. Would go for 12-15 minutes + discussion/Q&A. Can you confirm the slot so that I can start to prepare some slides and maybe demo? And could you give me some details on the software to use for VC and maybe other things I should know? Thanks! Never watched one so far, but will probably do so before Monday to know what to expect.
Amazing! Yes, that sounds great. We meet via Zoom, and most of the time, folks walk through a few slides and share a demo, then take questions from the community.
Sounds good! See you there!
Modo🧯 v0.10.0 is out and brings some major usability improvements:
- Command
init now analyzes the structure of the Mojo project and sets everything up to work instantly.
- Flag --watch introduces a watch mode, so that edits can be reviewer in a web browser instantly.
- Flag --report-missing reports missing docstrings and a documentation coverage percentage.
- Command clean cleans up a project from Markdown and test files generated by Modo.