README.md

@grafana/plugin-docs-cli

CLI tool for developing, validating and previewing Grafana plugin documentation locally.

Usage

The CLI reads docsPath from your plugin's src/plugin.json to locate the docs folder.

npx @grafana/plugin-docs-cli serve
npx @grafana/plugin-docs-cli serve --port 3001 --reload

For the core parsing library, see @grafana/plugin-docs-parser.

Writing docs

Start with Add documentation to your plugin on the developer portal. The authoring guide covers page shape, style and keeping docs in sync with your plugin's source. Pages are plain markdown, see docs/supported-markdown.md for everything you can use and how to write it. To move existing docs from the docs website, see docs/migrate-from-docs-website.md.

The guides are published with the package, so AI agents and authors can read the version that matches their installed CLI from node_modules/@grafana/plugin-docs-cli/docs/, starting at index.md. validate prints the path at the end of its output. Under Yarn PnP, where the package is zipped and can't be read from disk, it prints a GitHub URL pinned to the installed version instead.

Validation rules

validate and serve check your docs folder against a set of rules covering file structure, frontmatter, images and links. validate --dist checks the docs your plugin build ships instead, including manifest.json. See docs/validation-rules.md for the full list and what each one checks.