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

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

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

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

Last synced: about 1 month ago
JSON representation

This open-source template offers a clean design for comprehensive documentation and engaging blog content.

Awesome Lists containing this project

README

        

## AriaDocs - Documentation Template

A versatile, open-source documentation template supporting multiple frameworks.

### Templates

- **Next.js Base:** Full-featured documentation with SSR and SSG.
[View Template](https://github.com/nisabmohd/Aria-Docs/tree/master/nextjs-base)

- **Next.js Minimal:** Lightweight documentation for simple needs.
[View Template](https://github.com/nisabmohd/Aria-Docs/tree/master/nextjs-minimal)

- **Next.js i18n:** Multilingual support for global audiences.
[View Template](https://github.com/nisabmohd/Aria-Docs/tree/master/nextjs-i18n)

- **React Router Base:** Documentation with React Router Framework.
[View Template](https://github.com/nisabmohd/Aria-Docs/tree/master/react-router-base)

- **TanStack Start Base:** Documentation setup powered by TanStack Router.
[View Template](https://github.com/nisabmohd/Aria-Docs/tree/master/tanstack-start-base)

### Quick Start

Create a new project:

```plaintext
npx ariadocs-cli
```

### Deploy

| Template | Deploy Link |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Next.js Base | [![Deploy](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/nisabmohd/Aria-Docs&project-name=nextjs-base&root-directory=nextjs-base) |
| Next.js Minimal | [![Deploy](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/nisabmohd/Aria-Docs&project-name=nextjs-minimal&root-directory=nextjs-minimal) |
| Next.js i18n | [![Deploy](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/nisabmohd/Aria-Docs&project-name=nextjs-i18n&root-directory=nextjs-i18n) |
| React Router Base | [![Deploy](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/nisabmohd/Aria-Docs&project-name=react-router-base&root-directory=react-router-base) |
| TanStack Start Base | [![Deploy](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/nisabmohd/Aria-Docs&project-name=tanstack-start-base&root-directory=tanstack-start-base&build-command=npm%20run%20build%20--%20--preset%20vercel) |

### Features

- SSR and SSG Support
- Multiple Frameworks (Next.js, React Router, TanStack Router)
- MDX for Interactive Docs
- TOC with Scroll Highlight
- Dark Mode
- i18n for Multilingual Docs
- Static and Dynamic Routing

### Support

Please consider sponsoring to keep this project alive.
[Sponsor Me](https://github.com/sponsors/nisabmohd)