pmndrs/docs
pmndrs/docs has 120 GitHub stars and 100 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-16 19:23 UTC. Last push 2026-11-09.
Measured star growth
- in 24h
- 0
- in 7 days
- Update delayed
- in 15 days
- Update delayed
- in 1 month
- Update delayed
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
🖨️ mdx static documentation generator
Web & AppsREADME.md
Originaldocs/getting-started/introduction.mdx
Usage
Read
$ 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 for keys, search and caching.
Build
$ 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 for formats, flags, previewing and docs.config.ts.
Releasing
Every push to main redeploys docs.pmnd.rs via ci.yml — no 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, 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.
pnpm run lgtm— the gate CI runs (lgtm.yml): types, lint, registry validation, unit tests.
