Introduction
This section provides an overview of Introduction.
Lorem ipsum dolor sit amet consectetur adipisicing elit. Numquam iste dolorum tempore consectetur explicabo tempora provident quia maxime, molestiae, facilis aperiam et, error illum vel ullam? Quis architecto dolore ullam
Getting Started
To begin using the Documentation Template, follow these simple steps: 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
Blockquotes
Blockquotes are useful for emphasizing key points or quoting external sources:
"Documentation is a love letter that you write to your future self." - Damian Conway
Feel free to use blockquotes to highlight important information or quotes relevant to your documentation.
Code Examples with switch
Here a custom tab component from shadcn ui is used.
import ThemeProvider from './theme-provider'
export default function RootLayout({ children }) {
return (
<html>
<body className="container">
<ThemeProvider>{children}</ThemeProvider>
</body>
</html>
)}
Conclusion
Thank you for choosing the Documentation Template for your project. Whether you're documenting software, APIs, or processes, we're here to support you in creating clear and effective documentation. Happy documenting!