@pmndrs/docs

A static MDX documentation generator with a GitHub reusable workflow, primarily used for pmndrs/* projects.

[!NOTE] > This tool is open for everyone! While this repo is intended for building pmndrs documentation, anyone can use it to generate their own static docs site.

Quick Start

Clone this repo and run it locally:

git clone https://github.com/pmndrs/docs.git
cd docs
npm ci
npm run dev:full

Full Documentation

See docs/getting-started/introduction.mdx for complete documentation including configuration options, theming, and advanced features.