About this Post

Create documentation with markdown.

1 min read

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.

Brent JacksonBrent Jackson@jxnblk
Build docs with Next.js and MDX
Loading...

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.

Markdown Syntax Cheat Sheet

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.

Post Meta

Post By Manny BecerraPublished on August 29, 2018

Hola 👋🏽 Manny here. I'm a creative technologist and people-centric leader that supports teams to thrive sustainably, individually and collectively, with cross-functional alignment.

I operate from a place of compassion, possibility and imagination. My work and efforts share a common goal: create a better, sustainable and equitable world by building inclusive communities, products & experiences.

Post Keywords

APICSSCode BlocksComponentsDesign SystemsDocumentationGitHubLive EditMDX DocsMarkdownNext.jsOpen Source (OSS)ReactReact LiveThemingZeit