souporserious / mdxts

The Content and Documentation SDK for React

The Content & Documentation SDK for React

MDXTS is a collection of components and utilities for rendering
MDX content, type documentation, and code examples in React.

Features

• 📝 Quickly start authoring MDX
• ✅ Type-check content
• 📘 Generate type documentation
• 📊 Gather module metadata
• 🖼️ Preview source code examples
• 📁 Generate file-based routes
• 🌈 Accurately highlight code blocks

Getting Started

Using MDXTS in Next.js is currently the easiest way to get started. Follow the manual setup or use the CLI in a Next.js project to automate the plugin configuration:

npm create mdxts

After installing the package and required dependencies, you can start creating content or documentation using MDX. Simply render MDX as pages or use the createSource function to create a source for rendering a collection of MDX files:

import { createSource } from 'mdxts'

const posts = createSource('docs/*.mdx')

export default async function Page({ params }) {
  const { Content } = await posts.get(params.slug)
  return <Content />
}

Visit the Getting Started guide to view the full documentation and learn more about the features and capabilities of MDXTS.

License

MIT © souporserious