AriaDocs: Documentation Template

Aria-Docs

A documentation-building library for React and Next.js. Render MDX content, organize docs with _meta.json, and build modern documentation sites with minimal setup.

🌐 Website: ariadocs.vercel.app

Packages

Quick Links

• Documentation & API Reference - Full usage guide, API reference, and examples
• Installation - Get started with @ariadocs/react

Features

• 📝 MDX Support - Write documentation in MDX with full React component support
• 🗂️ Navigation - Auto-generate navigation from _meta.json files
• 🎨 Syntax Highlighting - Built-in Prism.js integration for code blocks
• ⚡ Server Components - Full support for React Server Components
• 🔌 Plugin System - Extensible with remark/rehype plugins

Quick Start

1
pnpm add @ariadocs/react

1
import { createDocs } from "@ariadocs/react";
2
import {
3
  remarkGfm,
4
  rehypePrism,
5
  rehypeSlug,
6
  rehypeAutolinkHeadings,
7
  rehypeCodeTitles,
8
} from "@ariadocs/react/plugins";
9

10
export const docs = createDocs({
11
  contentDir: "contents/docs",
12
  remarkPlugins: [remarkGfm],
13
  rehypePlugins: [
14
    rehypeSlug,
15
    rehypeAutolinkHeadings,
16
    rehypeCodeTitles,
17
    rehypePrism,
18
  ],
19
});

👉 See full documentation for complete API reference, examples, and guides.

Development

1
# Install dependencies
2
pnpm install
3

4
# Build the library
5
pnpm --filter @ariadocs/react build
6

7
# Run the docs site
8
pnpm --filter web dev

License

MIT © Nisab Mohd