- Notifications
You must be signed in to change notification settings - Fork4
License
dagrs-dev/website
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
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 DocsLite Version: A streamlined, no-frills template perfect for straightforward documentation needs.
Explore the Lite VersionVersion with Versioning: A powerful option for projects that require historical documentation tracking. Manage multiple versions of your docs effortlessly.
Check out the Versioning Featurei18n Support Version (WIP): Designed for international audiences, this version will offer comprehensive multilingual support.
Preview the i18n Support
You can create a new Ariadocs project using the command:
npx create-aria-doc <project-directory>
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: // 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
First, run the development server:
npm run dev# oryarn dev# orpnpm dev# orbun dev
The easiest way to deploy your Next.js app is to use theVercel Platform from the creators of Next.js.
Check out ourNext.js deployment documentation for more details.
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. |