FireWorm 🔥🐛 - Easy Docs Website for your Mojo Project
Hey everyone!
I wanted to make public docs for Lightbug, but instead made a public documentation starter kit, FireWorm:
https://github.com/saviorand/fireworm
It's based on Basalt docs, with more features, and I've put quite a lot of effort into refining the frontend.
To start using it, just clone the repo or use the Github template, then add the output of
mojo doc for your project into the root. Don't forget to update docs.config.json with your project's links and descriptions.
For now only automatically generated docs made with mojo doc are supported. I plan to add the ability to create custom pages with Markdown for free-form wiki-style docs later.
If you like it, feel free to star the repo! And, as always, contributors are welcome.GitHub
GitHub - saviorand/fireworm: Easy Docs Website for your Mojo Projec...
Easy Docs Website for your Mojo Projects 🔥🐛. Contribute to saviorand/fireworm development by creating an account on GitHub.
7 Replies
Wasn't the output format of
mojo doc explicitly unstable?Yes, but I couldn't wait 😁 will update the models in this project if something changes, tried to keep them consolidated
Are you keeping this on stable or nightly?
This repo doesn't have any Mojo code, it's all Typescript. But for the
mojo doc output I'll aim for stableWhat I mean is that the doc output will change on nightly first, then stable.
That should give me a bit of a notice to be able to update the models in time if I see any changes on nightly
Also posted on the forum https://forum.modular.com/t/fireworm-easy-docs-website-for-your-mojo-project/142/1
Modular
FireWorm 🐛 - Easy Docs Website for your Mojo Project
Hey everyone! I wanted to make public docs for Lightbug, but instead made a public documentation starter kit, FireWorm: It’s based on Basalt docs, with more features, and I’ve put quite a lot of effort into refining the frontend. To start using it, just clone the repo or use the Github template, then add the output of mojo doc for your proje...