Mo2Docs ⚡ - Mojo Docs to Webpage Generator

Automatically give your Mojo :fire: project a beautiful documentation webpage

Repo: https://github.com/endia-ai/Mo2Dox/

A working example: https://endia.vercel.app/

Quick Start:

git clone https://github.com/endia-ai/mo2dox.git && \
cd mo2dox && \
npm install && \
npm run dev

Features:

  • Automatic MDX generation: Seamless conversion from Mojo documentation, building on top of the JSON that the mojo doc command creates
  • Design: Clean, responsive interface for all devices (thanks Nextra)
  • Search: Built-in search functionality for easy navigation (big thanks Nextra)

Mo2Dox is just a thin wrapper over Nextra, and I do not take cedit for most of the cool features.

I’d be happy to get some feedback if it works for your Mojo projects too. Feel free to file issues and pull requests.

5 Likes

I have added a second template for creating Mojo Docs - now via Material for Mkdocs :fire:

Generate Docs via Nextra:

git clone https://github.com/endia-ai/Mo2Dox.git
cd Mo2Dox/nextra
npm install
npm run dev

or via Mkdocs:

git clone https://github.com/endia-ai/Mo2Dox.git
cd Mo2Dox/mkdocs
pip install mkdocs mkdocs-material
mkdocs serve