Whoa! I just came across MDX Docs, a tool built by Brent Jackson, that offers a potentially easier way to create and maintain app, design, and component documentation.
Per the official MDX site, MDX allows you to use JSX in your markdown content
. Though MDX Docs is built for Next.js (created by the Zeit Crew), MDX gets compiled to JavaScript that can be used in any framework that supports JSX
.
According to the repo, MDX Docs has the following features out-of-the-box:
- Create documentation with markdown
- Import and use React components
- Component-based API
- Live code examples
- Customizable themes
- Built for Next.js
That's an awesome feature list!
Looking forward to exploring this more and seeing if I can use it for some of my Next.js projects.