{"repo":"mlange-42/modo","free":true,"listed":false,"github":"https://github.com/mlange-42/modo","clone":"git clone https://github.com/mlange-42/modo.git","description":"Modo🧯 -- DocGen for Mojo🔥","language":"Go","stars":15,"topics":["docs","documentation","markdown","mojo","mojolang","docgen","docgenerator"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Modo🧯 Modo🧯 is a documentation generator (DocGen) for the Mojo🔥 programming language. It generates Markdown for static site generators (SSGs) from mojo doc JSON output. This example in the User guide shows a Mojo🔥 package processed with Modo🧯 and rendered with Hugo, to demonstrate Modo🧯's features. Features Generates Mojo🔥 API docs for Hugo, mdBook or just plain Markdown. Super easy to set up for an existing Mojo🔥 project. 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. See the User guide for more information. See the Modo🧯 slides for a feature overview. Installation Using Python Modo🧯 is available on PyPI as pymodo . Install it with pip: This installs the modo command. If the command is not found, try: python -m pymodo Using Go With Go installed, you can install Modo🧯 like this: With Go, you can also install the latest development version : go install github.com/mlange-42/modo@main Precompiled binaries Pre-compiled binaries for manual installation are available in the Releases for Linux, Windows and MacOS. Usage To initialize an existing Mojo🔥 project for Modo🧯 and an SSG like Hugo, run command init once: This sets up everything to be able to build Markdown files for the target SSG with command build : Finally, serve or build the site with the target SSG (here Hugo): See Project setup for de","default_branch":null,"files":null,"tree":[],"storefront":"/r/mlange-42","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/mlange-42/modo/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}