docs
🖨️ mdx static documentation generator
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/pmndrs/docs with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/pmndrs/docs'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/pmndrs--docs)HTML
<a href="/listings/pmndrs--docs"><img src="/api/listings/pmndrs--docs/badge.svg" alt="findsafeskills safety rating" /></a>Install
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 42 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- [](https://www.chromatic.com/library?appId=6977e41687a50b30c4349650&branch=main)
- [](docs/getting-started/introduction.mdx)
- [docs/getting-started/introduction.mdx](docs/getting-started/introduction.mdx)
- # Usage
- ## Read
- ```sh
- $ npx @pmndrs/docs # the reader: every library, every page
- $ npx @pmndrs/docs drei # straight into one
- $ npx @pmndrs/docs drei/performances/instances # straight to a page
- $ npx @pmndrs/docs search instanced mesh # one result per line, on stdout
- ```
- See [read](docs/getting-started/introduction.mdx#read) for keys, `search` and caching.
- ## Build
- ```sh
- $ cat foo.mdx | npx @pmndrs/docs@latest build # one HTML fragment, on stdout
- $ npx @pmndrs/docs@latest build docs out # one .html per .mdx, assets alongside
- $ npx @pmndrs/docs@latest build docs out --format website # the whole website, statically exported
- ```
- See [CLI](docs/getting-started/introduction.mdx#cli) for formats, flags, previewing and `docs.config.ts`.
- # Releasing
- Every push to `main` redeploys [docs.pmnd.rs](https://docs.pmnd.rs) via [ci.yml](.github/workflows/ci.yml) — no [changeset](.changeset/) needed for that.
- Add one (`pnpm changeset`) only when downstream consumers pinning `pmndrs/docs/.github/workflows/build.yml@v4` or `@pmndrs/docs@4` should pull the change. It bumps [`package.json`](package.json), publishes to npm, and tags `vX.Y.Z` + `vX` — so `@v4` resolves to the latest.
- TL;DR — site-only tweak: skip. Anything consumers see (workflow, build behavior, templates): add one.
- # Test
- Visual tests are performed in the cloud, through [chromatic-storybook.yml](.github/workflows/chromatic-storybook.yml).
- - `pnpm run lgtm` — the gate CI runs ([lgtm.yml](.github/workflows/lgtm.yml)): types, lint, registry validation, unit tests.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.