The renoun toolkit uses your React framework to keep
documentation polished, in sync, and on brand.
npx create-renoun@latest
- 📝 Author MDX content
- 📊 Query and analyze file system metadata
- 🛟 Validate module exports
- 📘 Generate up‑to‑date API references
- 🌈 Highlight code accurately
- ✅ Type‑check code blocks
- 🖼️ Render code previews
- 📦 Integrate with your favorite framework
These apps are built with Next.js and showcase different ways to use renoun.
- Blog — blog starter with a post index, tags, and MDX article pages (Demo · Source)
- Docs — documentation starter that turns MDX content into a polished, full-featured site (Demo · Source)
- Workbench — design system workbench for building, previewing, and documenting libraries (Demo · Source)
Maintaining consistent technical documentation at scale is hard, especially for design systems. The renoun toolkit simplifies this by providing a React‑first solution to author, validate, and render documentation that stays in sync with your code every step of the way.
To create a new project or add to an existing project, run the following command in your terminal:
npx create-renoun@latestThis will prompt you to select an example to install.
To install renoun manually, run the following command in your terminal:
npm install renounAfter installing the package, you can start creating content using your favorite framework.
See the Contributing Guide for details on how to contribute to renoun.
The renoun source code is provided under the non-commercial renoun license ideal for blogs, documentation sites, and educational content. If you plan to integrate renoun into a commercial product or service, reach out to [email protected] to discuss options.