M
Modular•4d ago
TilliFe

Mo2Dox ⚡

Give your Mojo :mojo: project a beautiful documentation webpage automatically 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
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.
No description
No description
4 Replies
mlange-42
mlange-42•4d ago
Getting 404 for the link.
DobyDabaDu
DobyDabaDu•4d ago
Hmm, it works similar to modular mojo docs, doesn't it? Looks cool and can be helpful for mojo pacakge developers 👍:mojo:
TilliFe
TilliFeOP•2d ago
it builds on top of the json that the mojo doc command creates. it converts the json to mdx and provides a template for rendering the mdx files via Nextra, that's it, nothing crazy indeed. I have added a second template for creating Mojo Docs - now via Material for Mkdocs :mojo: Generate Docs via Nextra: 
git clone https://github.com/endia-ai/Mo2Dox.git
cd Mo2Dox/nextra
npm install
npm run dev
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
git clone https://github.com/endia-ai/Mo2Dox.git
cd Mo2Dox/mkdocs
pip install mkdocs mkdocs-material
mkdocs serve
TilliFe
TilliFeOP•2d ago
Example Docs when using Mkdocs.
No description

Did you find this page helpful?