Detailed Installation Guide

Complete guide to installing AkiraDocs in different environments.

Prerequisites

Ensure your system meets the [requirements](../getting-started/requirements.md) before proceeding.

Installation Methods

1. Local Development Setup

1. Create New Project

1npx create-akiradocs@latest my-docs-site
2cd my-docs-site

2. Install Dependencies
Dependencies are automatically installed during project creation. If you need to reinstall:

1npm install

3. Create Environment File
The environment file is created automatically. You can modify it at `.env.local`

4. Start Development Server

1npm run dev

5. Update AkiraDocs
To update an existing installation to the latest version:

1npx create-akiradocs@latest update

3. Cloud Platform Deployment

Vercel

1. Fork the repository
2. Connect to Vercel
3. Configure environment variables
4. Deploy

Other Platforms

  • AWS Amplify (Coming Soon)
  • Netlify (Coming Soon)
  • Digital Ocean (Coming Soon)
  • Custom server (Coming Soon)

Post-Installation Steps

1. Verify Installation

1npm run build
2npm run start

2. Configure Git Integration

1git remote add origin your-repository-url

3. Setup Content Directory

1mkdir -p docs/_contents/en

Environment-Specific Configurations

Development

1NODE_ENV=development
2DEBUG=true

Production

1NODE_ENV=production
2DEBUG=false

Testing

1NODE_ENV=test
2TEST_MODE=true