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

npm install omnidoc

After installing the package and required dependencies, you can start creating content or documentation using any framework that supports React Server Components.

To get started, use the createCollection function to render a collection of files from the file system:

import { createCollection } from 'omnidoc/collections'

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

export default async function Page({ params }) {
  const Content = await posts
    .getSource(params.slug)
    .getDefaultExport()
    .getValue()

  return <Content />
}

There are many different components to help facilitate writing technical content. Visit the site to view the full documentation and learn more about the features and capabilities of Omnidoc.

License

AGPLv3 © souporserious