On this page

Quick Start Install Generate Embed Media

Quick Start

MoonDocKit turns MoonBit package notes into a small reviewable documentation site.

• parse front matter
• render HTML pages
• generate navigation
• build a search index
• generate MoonBit API documentation

Install

After publication, add Estrella-11/moondockit from mooncakes.io.

Generate

Generate the project interface and build a site:

moon info
moon run --target js cmd/moondockit --source docs --api pkg.generated.mbti --output dist --language en --description "Package documentation"

The CLI validates the site, reports its quality score, and writes a root page, HTML documentation, search data, sitemap, and crawler policy.

Use --footer and --site-url to add release attribution and canonical metadata. Invalid arguments or a failed quality gate produce a non-zero exit code in the compiled Node.js CLI.

Embed

Use the library API to build an output manifest, then write every OutputFile through your preferred backend. See https://www.moonbitlang.com for language documentation.

Media

Markdown image syntax is supported with escaped alt text and safe source URLs: