Skip to content

About

Information about the documentation site itself: its structure, toolchain, authoring workflows, publishing process, and conventions for contributors (human and AI).

The documentation site uses two custom remark plugins that transform Markdown at build time. Authors do not need to configure anything — just follow the authoring conventions and the plugins do the rest.

PluginWhat it does
remark-resolve-md-linksRewrites relative .md links to Starlight’s directory-based URL structure. Authors write standard file-path links; the plugin handles URL conversion.
remark-plantumlRenders plantuml fenced code blocks into inline SVG images. No external service required.

Both plugins are registered in astro.config.mjs and run automatically on every build.