Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nisabmohd/aria-docs

This open-source documentation template, made with Next.js, offers a clean design for comprehensive documentation and engaging blog content.
https://github.com/nisabmohd/aria-docs

blog contributions-welcome documentation documentation-template mdx next-mdx-remote nextjs nextjs14 nextjs15 opensource react react19 rehype-plugin remarkjs server-components servercomponent shadcn-ui tailwindcss typescipt vercel

Last synced: 2 days ago
JSON representation

This open-source documentation template, made with Next.js, offers a clean design for comprehensive documentation and engaging blog content.

Awesome Lists containing this project

README 

        
## 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](https://github.com/nisabmohd/Aria-Docs/tree/master)



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

  [Explore the Lite Version](https://github.com/nisabmohd/Aria-Docs/tree/minimal-docs)



- **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](https://github.com/nisabmohd/Aria-Docs/tree/version_docs)



- **i18n Support Version (NEW):** Designed for international audiences, this version will offer comprehensive multilingual support.  

  [Preview the i18n Support](https://github.com/nisabmohd/Aria-Docs/tree/i18n-support)



### Quick Start



You can create a new Ariadocs project using the command:



```plaintext

npx create-aria-doc 

```



### 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 

2. Install dependencies:

   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.

   npm install --force 

3. Start the development server:

   npm run dev

```



## Getting Started



First, run the development server:



```plaintext

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](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.



Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.



[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/nisabmohd/Aria-Docs)



## Key Features



| **Feature**                   | **Description**                                          |

|-------------------------------|----------------------------------------------------------|

| MDX Support                   | Write interactive documentation with MDX.                |

| Nested Pages                  | Organize content in a nested, hierarchical structure.    |

| Blog Section                  | Include a dedicated blog section.                        |

| Table of Contents             | Auto-generated TOC for easy navigation.                  |

| Pagination                    | Split content across multiple pages.                     |

| Syntax Highlighting           | Highlight code for better readability.                   |

| Code Line Highlighting & Titles | Highlight specific lines with descriptive titles.      |

| Interactive Code Blocks       | Language-specific and interactive code display.          |

| Custom Components             | Embed custom, reusable components in your docs.          |

| Light & Dark Mode             | Toggle between light and dark themes.                    |

| Search Functionality          | Quickly find content with a built-in search.             |

| Code Switcher                 | Switch between code languages or variations.             |

| Code Copy                     | Copy code blocks with a single click.                    |

| TOC Observer Highlight        | Highlight active sections in the TOC as you scroll.      |

| Static Site Generation        | Generate a static, high-performance site.                |

| SEO-Optimized                 | Structured for optimal search engine indexing.           |

| Internationalisation (New)             | Added support for i18n for multiple languages |