Skip to content
Back to search

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.

Checked today

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
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/pmndrs--docs/badge.svg)](/listings/pmndrs--docs)

HTML

<a href="/listings/pmndrs--docs"><img src="/api/listings/pmndrs--docs/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

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.

  1. [![](https://img.shields.io/badge/docs--storybook-171c23.svg?style=flat&colorA=000000&colorB=000000&logo=chromatic&logoColor=ffffff)](https://www.chromatic.com/library?appId=6977e41687a50b30c4349650&branch=main)
  2. [![](docs/getting-started/gutenberg.jpg)](docs/getting-started/introduction.mdx)
  3. [docs/getting-started/introduction.mdx](docs/getting-started/introduction.mdx)
  4. # Usage
  5. ## Read
  6. ```sh
  7. $ npx @pmndrs/docs # the reader: every library, every page
  8. $ npx @pmndrs/docs drei # straight into one
  9. $ npx @pmndrs/docs drei/performances/instances # straight to a page
  10. $ npx @pmndrs/docs search instanced mesh # one result per line, on stdout
  11. ```
  12. See [read](docs/getting-started/introduction.mdx#read) for keys, `search` and caching.
  13. ## Build
  14. ```sh
  15. $ cat foo.mdx | npx @pmndrs/docs@latest build # one HTML fragment, on stdout
  16. $ npx @pmndrs/docs@latest build docs out # one .html per .mdx, assets alongside
  17. $ npx @pmndrs/docs@latest build docs out --format website # the whole website, statically exported
  18. ```
  19. See [CLI](docs/getting-started/introduction.mdx#cli) for formats, flags, previewing and `docs.config.ts`.
  20. # Releasing
  21. 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.
  22. 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.
  23. TL;DR — site-only tweak: skip. Anything consumers see (workflow, build behavior, templates): add one.
  24. # Test
  25. Visual tests are performed in the cloud, through [chromatic-storybook.yml](.github/workflows/chromatic-storybook.yml).
  26. - `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 in

Free to use. If it’s helped, pass it on.