The documentation site for Mux, served at mux-lang.dev and built with Docusaurus. This repo also holds the docs AI assistant worker and the docs indexing tooling that powers it, since both are coupled to the docs content.
| Path | What it is |
|---|---|
docs/ |
Docusaurus documentation content (the language docs) |
src/ |
Site React components, pages, and the interactive playground |
static/ |
Static assets (logo, favicon, images) |
sidebars.ts, docusaurus.config.ts |
Docusaurus configuration |
workers/mux-ai/ |
Cloudflare Worker that answers questions over the docs (Vectorize + Workers AI) |
tools/docs-indexer/ |
Indexes docs/ into the mux-docs Vectorize index used by the worker |
npm install # install dependencies
npm start # run the dev server (http://localhost:3000)
npm run build # production build
npm run lint # eslint
npm run typecheck # tscThe site talks to the compile/run API (mux-website-api) and the AI worker over HTTP only; there is no build-time coupling to the compiler.
The site deploys to GitHub Pages on mux-lang.dev. Worker and indexer deploys
are documented in workers/mux-ai/README.md.
| Repo | What it is |
|---|---|
| mux-compiler | The language, compiler, and CLI (the canonical Mux version) |
| mux-runtime | Runtime + standard library linked by compiled programs |
| mux-website-api | Compile/run API behind the playground |
| tree-sitter-mux | Tree-sitter grammar + highlight queries |
| mux-syntax-highlighting | TextMate grammar, VSCode extension, canonical syntax spec |
| mux-context | Cross-repo architecture, design rationale, glossary, releases |
MIT - Maintained by Derek Corniello