Home
Softono

Aria Docs

Open source MIT TypeScript
414
Stars
72
Forks
5
Issues
4
Watchers
4 months
Last Commit

 About Aria Docs

A lightweight documentation builder for React and Next.js, designed for speed, simplicity, and minimal setup.

Platforms

Web Self-hosted

Languages

TypeScript

Need Help Installing Aria Docs?

We provide expert installation service for this software. Our team will install, configure, and secure Aria Docs on your server. plans start at just $30.

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

Package Description
@ariadocs/react Core library for building docs sites

Quick Links

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

pnpm add @ariadocs/react
import { createDocs } from "@ariadocs/react";
import {
  remarkGfm,
  rehypePrism,
  rehypeSlug,
  rehypeAutolinkHeadings,
  rehypeCodeTitles,
} from "@ariadocs/react/plugins";

export const docs = createDocs({
  contentDir: "contents/docs",
  remarkPlugins: [remarkGfm],
  rehypePlugins: [
    rehypeSlug,
    rehypeAutolinkHeadings,
    rehypeCodeTitles,
    rehypePrism,
  ],
});

πŸ‘‰ See full documentation for complete API reference, examples, and guides.

Development

# Install dependencies
pnpm install

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

# Run the docs site
pnpm --filter web dev

License

MIT Β© Nisab Mohd