Installation
Installation guide for our application.
Setting up AriaDocs is straightforward, with options to clone the repository or use the convenient npx command. AriaDocs requires Node.js version 18 or higher for optimal performance.
Clone Repository
To get started, you can clone the AriaDocs repository directly from GitHub.
1
Step 1: Clone the AriaDocs Repository
Begin by cloning the AriaDocs repository from GitHub:
git clone https://github.com/nisabmohd/Aria-Docs.git
2
Step 2: Access the Project Directory
After cloning, navigate into the project directory to start setting up:
cd Aria-Docs
3
Step 3: Install Required Dependencies
Install all necessary project dependencies with npm:
npm install
4
Step 4: Launch the Development Server
Finally, start the development server to view the project locally:
npm run dev
Quick Setup with npx
For a faster setup, use the npx command to create a new AriaDocs project in one step:
npx create-aria-doc <project-directory>
Command Output:
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
With this setup, you’ll have a ready-to-use AriaDocs instance to start building your documentation.