README.md

FireWorm

🔥 Docs for your Mojo projects 🔥

Overview

FireWorm lets you make a documentation website for your Mojo project.

Just run the mojo doc command on your codebase, add the resulting JSON to the project and start the server. You've got your public docs! 🔥 Update the docs.config.json file with the description for your project and a link to your Github repo to fetch the README for the home page (custom docs pages coming soon!).

Getting Started

First, copy the output of mojo doc to a docs.json file at the root of this repo.

Then, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

FireWorm is a NextJS application, so you can deploy it on Vercel or any other place you can host Next apps.

Contributors

Want your name to show up here? See CONTRIBUTING.md!

_{Made with contrib.rocks.}