MDX Docs – a lightweight React framework for documentation sites
Hey HN! I’m Ezra, the creator of MDX Docs. I built this because I wanted a fast, simple way to document components using Markdown and React together with MDX. The goal was to keep things really straightforward: pages are just MDX files, and they map directly to routes. You can write docs and drop in React components right alongside them without much setup. It also includes a CLI: npx create-mdx-docs@latest my-docs I’ve been using it to spin up docs sites quickly, and it’s been a really nice workflow so far. Curious how others are approaching documentation for components and internal tools these days. Happy to answer any questions.
- Content Creation
- Integrations
- Open Source
✨ AI Summary
MDX Docs is a lightweight React framework for creating documentation sites that uses MDX files as pages, which map directly to routes. It allows developers to write documentation in Markdown and embed React components with minimal setup.
Best For
React developers documenting component libraries, Teams building internal tool documentation, Developers seeking a fast way to spin up documentation sites
Why It Matters
It provides a straightforward workflow for creating documentation by combining Markdown content with interactive React components in a single framework.
Key Features
- Pages are MDX files that map directly to routes
- Write documentation and embed React components side-by-side
- Includes a CLI for quick project setup
- Fast and straightforward setup process
Use Cases
- A frontend team lead needs to create living documentation for their design system. They want developers to see interactive component examples alongside usage guidelines, and they need to update documentation quickly whenever components change.
- An open-source maintainer is tired of maintaining separate documentation websites for multiple React libraries. They want a unified docs site where contributors can write tutorials with live code demos embedded directly in the documentation pages.
- A product manager at a SaaS company needs to create internal documentation for their team's dashboard tools. They want non-technical team members to write guides in Markdown while engineers embed configuration widgets to demonstrate settings.