Skip to content

souporserious/renoun

Repository files navigation

renoun

The Documentation Toolkit for React

The renoun toolkit uses your React framework to keep
documentation polished, in sync, and on brand.

npx create-renoun@latest

Features

  • 📝 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

Examples

Blog Demo Source MDX-powered blog with collections and post organization
Docs Demo Source Next.js docs site with MDX, custom UI, and Tailwind CSS
Package Demo Source Component library with MDX docs, examples, and hooks

Why renoun?

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.

Install

Automated

To create a new project or add to an existing project, run the following command in your terminal:

npx create-renoun@latest

This will prompt you to select an example to install.

Manual

To install renoun manually, run the following command in your terminal:

npm install renoun

After installing the package, you can start creating content using your favorite framework.

Contributing

See the Contributing Guide for details on how to contribute to renoun.

License

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.

© souporserious LLC

Sponsor this project

 

Packages

No packages published

Contributors 8

Languages