Skip to content
/ Aria-Docs Public template

This open-source Next.js template provides a sleek and responsive design for comprehensive documentation and engaging blog content.

License

Notifications You must be signed in to change notification settings

nisabmohd/Aria-Docs

Repository files navigation

AriaDocs - Documentation Template

This feature-packed documentation template, built with Next.js, offers a sleek and responsive design, perfect for all your project documentation needs.


Here are all versions of the AriaDocs template, each crafted for specific use cases:

  • Advanced Docs: A comprehensive template offering extensive features for in-depth documentation needs. Perfect for larger projects that require detailed explanations and advanced configurations.
    Explore the Advanced Docs

  • Lite Version: A streamlined, no-frills template perfect for straightforward documentation needs.
    Explore the Lite Version

  • Version with Versioning: A powerful option for projects that require historical documentation tracking. Manage multiple versions of your docs effortlessly.
    Check out the Versioning Feature

  • i18n Support Version (WIP): Designed for international audiences, this version will offer comprehensive multilingual support.
    Preview the i18n Support

Quick Start

You can create a new Ariadocs project using the command:

npx create-aria-doc <project-directory>

Expected Output

When you run the CLI, you can expect an output similar to this:

Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   npm install
3. Start the development server:
   npm run dev

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Deploy with Vercel

Got it! Here's a way to present the features in a more structured and visually appealing way using a table:

Features

Features
├── MDX supported
├── Nested pages support
├── Blog section (New)
├── Syntax highlighting
├── Table of contents
├── Pagination
├── Search
├── Code line highlight & code title
├── Static site generation
├── Custom components
├── Light mode & dark mode
├── Code Switcher
├── Code copy
└── Table of content observer highlight