# Table of Contents - [Quickstart Guide | Akira Docs](#quickstart-guide-akira-docs) - [Akira Docs](#akira-docs) - [Akira Docs](#akira-docs) - [Robots.txt Configuration | Akira Docs](#robots-txt-configuration-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [AkiraDocs Features | Akira Docs](#akiradocs-features-akira-docs) - [Creating and Organizing Pages | Akira Docs](#creating-and-organizing-pages-akira-docs) - [Setting Up Internationalization | Akira Docs](#setting-up-internationalization-akira-docs) - [AI-Powered Translation | Akira Docs](#ai-powered-translation-akira-docs) - [Editor Features | Akira Docs](#editor-features-akira-docs) - [Automatic Sitemap Generation | Akira Docs](#automatic-sitemap-generation-akira-docs) - [Introduction to AkiraDocs | Akira Docs](#introduction-to-akiradocs-akira-docs) - [Analytics Integration | Akira Docs](#analytics-integration-akira-docs) - [System Requirements | Akira Docs](#system-requirements-akira-docs) - [Code of Conduct | Akira Docs](#code-of-conduct-akira-docs) - [Detailed Installation Guide | Akira Docs](#detailed-installation-guide-akira-docs) - [Configuration Guide | Akira Docs](#configuration-guide-akira-docs) - [API Documentation Guide | Akira Docs](#api-documentation-guide-akira-docs) - [Managing Translations | Akira Docs](#managing-translations-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [Contributing to AkiraDocs | Akira Docs](#contributing-to-akiradocs-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [Troubleshooting Guide | Akira Docs](#troubleshooting-guide-akira-docs) - [Editor Overview | Akira Docs](#editor-overview-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [Documentation | Akira Docs](#documentation-akira-docs) - [Email Protection | Cloudflare](#email-protection-cloudflare) - [Documentation | Akira Docs](#documentation-akira-docs) --- # Quickstart Guide | Akira Docs Quickstart Guide ================ Get up and running with AkiraDocs in minutes. Quick Deploy ------------ ### Option 1: Deploy with Vercel The fastest way to get started is using Vercel: \[!\[Deploy with Vercel\](https://vercel.com/button)\](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template) ### Option 2: Using CLI Create a new project using our CLI: 1npx create-akiradocs@latest my-docs Basic Setup Steps ----------------- 1\. **Clone the Repository** (if not using Quick Deploy) 1git clone https://github.com/your-org/akira-docs-template 2cd akira-docs-template 2\. **Install Dependencies** 1npm install 2# or 3yarn install 3\. **Start Development Server** 1npm run dev 2# or 3yarn dev 4\. Open \`http://localhost:3000\` in your browser Initial Configuration --------------------- 1\. **Update Site Configuration** Edit \`akiradocs.config.json\`: 1{ 2 "site": { 3 "title": "Your Docs", 4 "description": "Your documentation description" 5 } 6} 2\. **Configure Translation** (Optional) 1{ 2 "translation": { 3 "auto_translate": true, 4 "provider": "anthropic", 5 "targetLanguages": ["es", "fr", "de"] 6 } 7} [PreviousRequirements](/en/docs/getting-started/requirements) [NextFeatures](/en/docs/getting-started/features) --- # Akira Docs Next-gen documentation powered by AI Search [Legacy View](/en/docs) Recommended Articles -------------------- [View all articles →](/en/articles) --- # Akira Docs Loading... --- # Robots.txt Configuration | Akira Docs Robots.txt Configuration ======================== The robots.txt file is automatically generated during the build process and can be found in the \`public\` folder of your project. Default Configuration --------------------- ### Basic robots.txt 1User-agent: * 2Allow: / 3Sitemap: https://docs.akiradocs.com/sitemap.xml 4 5# Private sections 6Disallow: /admin/ 7Disallow: /private/ [PreviousSitemap Generation](/en/docs/seo-and-performance/sitemap-generation) [NextUsage Guide](/en/docs/api-reference/usage-guide) --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # AkiraDocs Features | Akira Docs AkiraDocs Features ================== A comprehensive overview of AkiraDocs' core features and capabilities. Content Creation & Management ----------------------------- * **Notion-like Editor**: Intuitive block-based interface with real-time preview * **Markdown Support**: Native Markdown and MDX compatibility * **Custom Components**: Create and reuse your own content blocks Internationalization & Translation ---------------------------------- * **Multi-Language Support**: Maintain documentation in multiple languages * **AI-Powered Translation**: Automated, context-aware content translation * **Translation Management**: Built-in tools for managing localized content Search & Discovery ------------------ * **AI-Powered Search**: Natural language question answering with context awareness * **SEO Optimization**: Automated SEO tools and optimizations * **Smart Indexing**: Real-time search index updates Build & Performance ------------------- * **Static Generation**: Optimized build process with asset optimization * **Developer Experience**: Fast refresh and comprehensive debugging tools * **Performance Focus**: Built-in best practices for speed and efficiency Enterprise Features (Coming Soon) --------------------------------- * **Security & Compliance**: SSO, RBAC, and audit logging * **Analytics & Insights**: Usage tracking and documentation metrics * **Team Collaboration**: Enterprise-grade collaboration tools Migration Support (Coming Soon) ------------------------------- 1# Supported platforms for easy migration 2✓ Nextra 3✓ GitBook 4✓ Docusaurus 5✓ ReadTheDocs [PreviousQuickstart Guide](/en/docs/getting-started/quickstart) [NextSetup](/en/docs/installation/setup) --- # Creating and Organizing Pages | Akira Docs Creating and Organizing Pages ============================= Learn how to create, structure, and organize your documentation pages in AkiraDocs. You can create markdown pages or just use the editor UI. Note in \_contents folder, you will only see markdown content created by you. If you use Editor UI, the content will be saved in the compiled folder and will be automatically translated to other languages. Page Structure -------------- ### Basic Page Template 1--- 2title: Your Page Title 3description: Brief description of the page 4author: Your Name 5publishDate: 2024-11-26 6modifiedDate: 2024-11-26 7category: Category Name 8keywords: 9 - keyword1 10 - keyword2 11--- 12 13# Main Title 14 15Content starts here... ### Directory Structure 1folder_name/ 2├── _contents/ 3│ ├── en/ 4│ │ ├── getting-started/ 5│ │ ├── guides/ 6│ │ └── api/ You can just create pages for default language (en) and AkiraDocs will automatically translate them to other languages. Creating New Pages ------------------ ### Method 1: Using the UI 1\. Click "New Page" in the sidebar 2\. Start adding content ### Method 2: Direct File Creation 1\. Create a new \`.md\` file in the appropriate directory 2\. Add required frontmatter 3\. Write content using Markdown 4\. Save and compile Page Organization ----------------- ### Categories and Tags * Use consistent categories * Apply relevant tags * Organize by topic * Create logical hierarchies ### Navigation Structure This is automatically generated from the folder structure. You can customize it by editing the \`\_meta.json\` file inside compiled folder. 1{ 2 "docs": { 3 "getting-started": { 4 "title": "Getting Started", 5 "items": { 6 "introduction": { 7 "title": "Introduction", 8 "path": "/docs/getting-started/introduction" 9 } 10 } 11 } 12 } 13} [PreviousTroubleshooting](/en/docs/installation/troubleshooting) [NextOverview](/en/docs/editor/overview) --- # Setting Up Internationalization | Akira Docs Setting Up Internationalization =============================== Configure AkiraDocs for multiple languages with AI-powered translation support. Quick Setup ----------- ### Basic Configuration Add language settings to \`akiradocs.config.json\`: 1{ 2 "localization": { 3 "defaultLocale": "en", 4 "fallbackLocale": "en", 5 "locales": [\ 6 {\ 7 "code": "en",\ 8 "name": "English",\ 9 "flag": "�🇸"\ 10 },\ 11 {\ 12 "code": "es",\ 13 "name": "Español",\ 14 "flag": "🇪🇸"\ 15 },\ 16 {\ 17 "code": "fr",\ 18 "name": "Français",\ 19 "flag": "🇫🇷"\ 20 }\ 21 ] 22 }, 23 "translation": { 24 "auto_translate": true, 25 "provider": "anthropic", 26 "targetLanguages": ["es", "fr", "de"], 27 "excludedPaths": ["_meta.json"] 28 } 29} ### Directory Structure 1docs/ 2├── _contents/ 3│ ├── en/ # Source language 4│ │ └── docs/ 5│ ├── es/ # Spanish translation 6│ │ └── docs/ 7│ └── fr/ # French translation 8│ └── docs/ Configuration Options --------------------- ### Language Settings * \`defaultLocale\`: Primary content language * \`fallbackLocale\`: Fallback when translation missing * \`locales\`: Available language configurations ### Translation Settings * \`auto\_translate\`: Enable/disable automatic translation * \`provider\`: AI translation provider * \`targetLanguages\`: Languages to translate into * \`excludedPaths\`: Files to skip during translation [PreviousFeatures](/en/docs/editor/features) [NextManaging Translation](/en/docs/internationalization/managing-translation) --- # AI-Powered Translation | Akira Docs AI-Powered Translation ====================== Guide to using AkiraDocs' AI translation capabilities. Setup ----- ### Configuration 1{ 2 "translation": { 3 "auto_translate": true, 4 "provider": "anthropic", 5 "model": "claude-3-sonnet-20240229", 6 "targetLanguages": ["es", "fr", "de"], 7 "excludedPaths": ["_meta.json"] 8 } 9} ### API Setup 1ANTHROPIC_API_KEY=your_api_key Features -------- ### Automatic Translation * Content translation during build * Context-aware translations * Technical term preservation * Format maintenance [PreviousManaging Translation](/en/docs/internationalization/managing-translation) [NextSitemap Generation](/en/docs/seo-and-performance/sitemap-generation) --- # Editor Features | Akira Docs Editor Features =============== Detailed overview of AkiraDocs editor capabilities and features. Block System ------------ ### Text Formatting * **Basic Formatting** * Bold, italic, underline * Strikethrough * Highlight * Code inline * **Advanced Formatting** * Custom colors * Multiple fonts * Text alignment * Indentation ### Content Blocks #### Rich Text 1# Heading 1 2## Heading 2 3> Blockquote 4- Bullet list 51. Numbered list #### Code Blocks 1// Syntax highlighting 2console.log('Hello World'); #### Media Blocks * Image upload and embedding * Video embedding * File attachments * Interactive embeds AI Features ----------- ### Content Enhancement * Grammar and style suggestions * Content optimization * SEO recommendations * Translation assistance ### Smart Formatting * Auto-formatting * Smart lists * Table formatting * Code block language detection Collaboration Features ---------------------- ### Version Control * Git integration * Change history * Rollback capabilities [PreviousOverview](/en/docs/editor/overview) [NextSetup](/en/docs/internationalization/setup) --- # Automatic Sitemap Generation | Akira Docs Automatic Sitemap Generation ============================ Learn how AkiraDocs automatically generates and manages your documentation sitemap. Overview -------- AkiraDocs automatically generates a sitemap.xml file during the build process, ensuring search engines can efficiently crawl your documentation. Generated Sitemap Structure --------------------------- ### Example Output 1 2 3 4 https://yourdocs.com/ 5 2024-11-26 6 weekly 7 1.0 8 9 10 https://yourdocs.com/docs/getting-started 11 2024-11-26 12 weekly 13 0.8 14 15 [PreviousAI Translation](/en/docs/internationalization/ai-translation) [NextRobot.txt](/en/docs/seo-and-performance/robot-txt) --- # Introduction to AkiraDocs | Akira Docs Introduction to AkiraDocs ========================= AkiraDocs is a next-generation documentation platform that combines the power of AI with an intuitive content management system. It's designed to transform your documentation workflow from days to minutes. Why AkiraDocs? -------------- Documentation is often a challenge for teams: * Developers want to keep using Markdown and Git * Content teams need user-friendly editors * Technical writers struggle with version management * Product managers deal with out-of-sync documentation * Enterprise leaders need better analytics AkiraDocs solves these challenges by providing a unified platform that brings everyone's workflow together. Core Benefits ------------- * **Universal Workflow**: Developers keep their Markdown/Git workflow while content teams get a block-based WYSIWYG editor * **AI-Powered**: Automatic content updates, translations, and optimizations * **SEO-Optimized**: Documentation that ranks well by default * **Multi-Language Support**: AI-powered translations with context awareness * **Enterprise-Ready**: SSO/SAML integration, audit logs, and custom deployment options Who Is It For? -------------- ### Developer Documentation * API documentation * SDK guides * Technical specifications * Implementation guides ### Product Documentation * User guides * Feature documentation * Release notes * FAQs ### Enterprise Documentation * Internal knowledge bases * Process documentation * Compliance documentation * Training materials [NextRequirements](/en/docs/getting-started/requirements) --- # Analytics Integration | Akira Docs Analytics Integration ===================== Learn how to add analytics tracking to your documentation AkiraDocs supports Google Analytics 4 (GA4) out of the box. This guide will help you set up analytics tracking for your documentation. Setting up Google Analytics --------------------------- 1\. Create a Google Analytics 4 property in your \[Google Analytics account\](https://analytics.google.com/) 2\. Get your Measurement ID (starts with "G-") 3\. Add the ID to your \`akiradocs.config.json\`: 1{ 2"analytics": { 3"google": { 4"measurementId": "G-XXXXXXXXXX", 5"enabled": true 6}, 7"debug": false 8} 9} What's Tracked Automatically ---------------------------- * Page views * Navigation between pages * Time on page * User language preferences * Device and browser information Custom Event Tracking --------------------- You can track custom events using the \`useAnalytics\` hook: 1import { useAnalytics } from '@/hooks/useAnalytics' 2function MyComponent() { 3 const { track } = useAnalytics() 4 const handleClick = () => { 5 track('doc_rating', { 6 rating: 5, 7 page: 'getting-started', 8 helpful: true 9 }) 10 } 11 return 12} Debug Mode ---------- Enable debug mode to see analytics events in the console during development: 1{ 2"analytics": { 3"debug": true 4} 5} This provides a complete analytics integration that's easy for users to set up and extend as needed. [PreviousUsage Guide](/en/docs/api-reference/usage-guide) [NextHow to Contribute](/en/docs/contributing/how-to-contribute) --- # System Requirements | Akira Docs System Requirements =================== Before installing AkiraDocs, ensure your environment meets the following requirements. Minimum Requirements -------------------- ### Node.js * Version: 16.x or higher * Recommended: Latest LTS version ### System Memory * Minimum: 2GB RAM * Recommended: 4GB RAM or more ### Storage * Recommended: 1GB free space Software Dependencies --------------------- ### Required * Git (latest version recommended) * npm or yarn package manager * Modern web browser (Chrome, Firefox, Safari, Edge) ### Optional * Docker (for containerized deployment) * PostgreSQL (for enterprise features) Development Environment ----------------------- ### Supported Operating Systems * macOS (10.15 or later) * Windows 10/11 * Linux (Ubuntu 20.04 or later recommended) ### IDE/Editor Support * VS Code (coming soon) * WebStorm (coming soon) * Any text editor with Markdown support [PreviousIntroduction](/en/docs/introduction) [NextQuickstart Guide](/en/docs/getting-started/quickstart) --- # Code of Conduct | Akira Docs Code of Conduct =============== Our Pledge ---------- We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. Our Standards ------------- Examples of behavior that contributes to a positive environment: \* Demonstrating empathy and kindness toward other people \* Being respectful of differing opinions, viewpoints, and experiences \* Giving and gracefully accepting constructive feedback \* Accepting responsibility and apologizing to those affected by our mistakes \* Focusing on what is best for the overall community Examples of unacceptable behavior: \* The use of sexualized language or imagery, and sexual attention or advances \* Trolling, insulting or derogatory comments, and personal or political attacks \* Public or private harassment \* Publishing others' private information without explicit permission \* Other conduct which could reasonably be considered inappropriate in a professional setting Enforcement Responsibilities ---------------------------- Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Enforcement ----------- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly. Attribution ----------- This Code of Conduct is adapted from the \[Contributor Covenant\](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html. [PreviousHow to Contribute](/en/docs/contributing/how-to-contribute) --- # Detailed Installation Guide | Akira Docs 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 [PreviousFeatures](/en/docs/getting-started/features) [NextConfiguration](/en/docs/installation/configuration) --- # Configuration Guide | Akira Docs Configuration Guide =================== Complete guide to configuring your AkiraDocs installation. Core Configuration ------------------ ### Site Configuration Edit \`akiradocs.config.json\`: 1{ 2 "url": "https://docs.akiradocs.com", 3 "site": { 4 "title": "Your Docs", 5 "description": "Your documentation description" 6 }, 7 "branding": { 8 "logo": { 9 "path": "/your_logo.svg", 10 "width": 120, 11 "height": 30, 12 "show": true 13 }, 14 "favicon": { 15 "path": "/favicon.png", 16 "show": true 17 } 18 } 19} ### Navigation Setup 1{ 2 "navigation": { 3 "header": { 4 "items": [\ 5 { "label": "Docs", "href": "/docs", "icon": "/docs.svg" },\ 6 { "label": "API", "href": "/api", "icon": "/api.svg" }\ 7 ] 8 } 9 } 10} Internationalization -------------------- ### Language Configuration 1{ 2 "localization": { 3 "defaultLocale": "en", 4 "fallbackLocale": "en", 5 "locales": [\ 6 {\ 7 "code": "en",\ 8 "name": "English",\ 9 "flag": "🇺🇸"\ 10 },\ 11 {\ 12 "code": "es",\ 13 "name": "Español",\ 14 "flag": "🇪🇸"\ 15 },\ 16 {\ 17 "code": "fr",\ 18 "name": "Français",\ 19 "flag": "🇫🇷"\ 20 },\ 21 {\ 22 "code": "de",\ 23 "name": "Deutsch",\ 24 "flag": "🇩🇪"\ 25 }\ 26 ] 27 }, 28 "translation": { 29 "auto_translate": true, 30 "provider": "anthropic", 31 "model": "claude-3-sonnet-20240229", 32 "targetLanguages": ["es", "fr", "de"], 33 "excludedPaths": ["_meta.json"] 34 }, 35} [PreviousSetup](/en/docs/installation/setup) [NextTroubleshooting](/en/docs/installation/troubleshooting) --- # API Documentation Guide | Akira Docs API Documentation Guide ======================= Learn how to generate comprehensive API documentation using AkiraDocs. Quick Start ----------- ### Upload API Spec 1\. Place your OpenAPI/Swagger spec in: 1_contents/{language_code}/api/apiSpec.json 2\. AkiraDocs automatically generates documentation. ### Example API Spec 1{ 2 "openapi": "3.0.0", 3 "info": { 4 "title": "Sample API", 5 "version": "1.0.0" 6 }, 7 "paths": { 8 "/users": { 9 "get": { 10 "summary": "Get users", 11 "responses": { 12 "200": { 13 "description": "Success" 14 } 15 } 16 } 17 } 18 } 19} Generated Documentation ----------------------- ### Automatic Features * Interactive API explorer * Code samples in multiple languages * Request/response examples * Authentication documentation ### Example Output 1// Example: Get Users 2const response = await fetch('https://api.example.com/users', { 3 method: 'GET', 4 headers: { 5 'Authorization': 'Bearer YOUR_TOKEN' 6 } 7}); 8 9const users = await response.json(); Customization ------------- ### Theme Options 1{ 2 "api": { 3 "docs": { 4 "theme": "dark", 5 "syntaxHighlight": true, 6 "showExamples": true 7 } 8 } 9} ### Language Selection 1{ 2 "api": { 3 "examples": { 4 "languages": ["javascript", "python", "curl"] 5 } 6 } 7} [PreviousRobot.txt](/en/docs/seo-and-performance/robot-txt) [NextAnalytics Integration](/en/docs/guides/analytics) --- # Managing Translations | Akira Docs Managing Translations ===================== Learn how to effectively manage and maintain translated content in AkiraDocs. Translation Workflow -------------------- ### Automatic Translation 1\. Create content in source language 2\. Enable auto-translation in config 3\. Build/deploy to generate translations 4\. Review and refine translations ### Manual Translation 1\. Create language-specific directories 2\. Copy source content 3\. Translate manually 4\. Update metadata Content Organization -------------------- ### File Structure 1_contents/ 2├── en/ 3│ └── docs/ 4│ ├── intro.md 5│ └── guide.md 6├── es/ 7│ └── docs/ 8│ ├── intro.md 9│ └── guide.md 10└── fr/ 11 └── docs/ 12 ├── intro.md 13 └── guide.md Quality Control --------------- ### Review Process 1\. AI Translation 2\. Human Review 3\. Technical Verification 4\. Publication ### Version Control * Track changes across languages * Maintain synchronization * Handle updates efficiently [PreviousSetup](/en/docs/internationalization/setup) [NextAI Translation](/en/docs/internationalization/ai-translation) --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # Contributing to AkiraDocs | Akira Docs Contributing to AkiraDocs ========================= Guide to contributing to the AkiraDocs open-source project. Getting Started --------------- ### Setup Development Environment 1# Clone repository 2git clone https://github.com/Cloud-Code-AI/akiradocs 3cd akiradocs 4 5# Install dependencies 6npm install 7 8# Start development server 9npm run dev Contribution Guidelines ----------------------- ### Types of Contributions * Bug fixes * Feature additions * Documentation improvements * Translation help * Issue reporting ### Pull Request Process 1\. Fork the repository 2\. Create feature branch 3\. Make changes 4\. Submit pull request ### Commit Messages 1# Format 2type(scope): description 3 4# Examples 5feat(editor): add new block type 6fix(translation): correct language detection 7docs(api): update authentication guide Development Guidelines ---------------------- ### Code Style * Follow existing patterns * Use TypeScript * Add comments * Write tests ### Testing 1# Run tests 2npm run test 3 4# Check types 5npm run type-check 6 7# Lint code 8npm run lint Documentation ------------- ### Update Docs 1\. Edit relevant files 2\. Update examples 3\. Check links 4\. Verify formatting ### Create Examples * Clear and concise * Well-documented * Tested * Maintainable Getting Help ------------ * Join \[Discord\](https://discord.gg/zvYZukgeH2) * Check \[Issues\](https://github.com/Cloud-Code-AI/akiradocs/issues) * Read \[Documentation\](https://docs.akiradocs.com) [PreviousAnalytics Integration](/en/docs/guides/analytics) [NextCode of Conduct](/en/docs/contributing/code-of-conduct) --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # Troubleshooting Guide | Akira Docs Troubleshooting Guide ===================== Common issues and their solutions when setting up AkiraDocs. Common Installation Issues -------------------------- ### Node.js Version Mismatch **Problem**: Error about Node.js version compatibility 1Error: The engine "node" is incompatible with this module **Solution**: 1\. Check your Node.js version: 1node --version 2\. Install the correct version (16.x or higher) 3\. Use nvm to manage Node.js versions: 1nvm install 20 2nvm use 20 ### Dependencies Installation Failed **Problem**: npm install fails with errors **Solution**: 1\. Clear npm cache: 1npm cache clean --force 2\. Delete node\_modules and package-lock.json: 1rm -rf node_modules package-lock.json 2npm install Build Issues ------------ ### Build Fails **Problem**: \`npm run build\` fails **Solution**: 1\. Check for TypeScript errors: 1npm run type-check 2\. Verify environment variables are set correctly 3\. Clear next.js cache: 1rm -rf .next ### Static Export Issues **Problem**: Static export fails with dynamic routes **Solution**: 1\. Configure \`next.config.js\`: 1module.exports = { 2 output: 'export', 3 images: { 4 unoptimized: true 5 } 6} Translation Issues ------------------ ### AI Translation Not Working **Problem**: Automatic translation fails **Solution**: 1\. Verify API keys are set correctly 2\. Check translation configuration: 1{ 2 "translation": { 3 "auto_translate": true, 4 "provider": "anthropic", 5 "targetLanguages": ["es", "fr", "de"] 6 } 7} Content Issues -------------- ### Content Not Updating **Problem**: Changes to content files not reflecting **Solution**: Content changes are built on build time. If you are using the local development server, you need to restart the server after making changes. 1\. Clear the cache: 1npm run clean 2\. Restart the development server 3\. Check file permissions Deployment Issues ----------------- ### Vercel Deployment Failed **Problem**: Deployment to Vercel fails **Solution**: 1\. Check build logs 2\. Verify environment variables are set in Vercel dashboard 3\. Ensure all dependencies are listed in package.json Getting Help ------------ If you're still experiencing issues: 1\. Check our \[GitHub Issues\](https://github.com/Cloud-Code-AI/Akiradocs/issues) 2\. Join our \[Discord Community\](https://discord.gg/zvYZukgeH2) 3\. Contact \[Support\](mailto:[\[email protected\]](/cdn-cgi/l/email-protection) ) [PreviousConfiguration](/en/docs/installation/configuration) [NextCreating Pages](/en/docs/content-management/creating-pages) --- # Editor Overview | Akira Docs Editor Overview =============== AkiraDocs features a modern, Notion-like editor that combines the simplicity of block-based editing with the power of Markdown. Editor Interface ---------------- ### Main Components * **Toolbar**: Quick access to formatting options and block types * **Content Area**: Block-based editing space * **Sidebar**: Navigation and document structure * **Command Palette**: Quick commands (Ctrl/Cmd + P) ### Block Structure Each content element is a block that can be: * Dragged and dropped to reorganize * Converted between different types * Duplicated or deleted * Nested within other blocks Getting Started --------------- ### Creating Content 1\. Click the '+' button or press '/' to add a new block 2\. Choose block type from the popup menu 3\. Start typing or add content ### Basic Operations 1/ → Open block menu 2⌘/Ctrl + P → Command palette 3⌘/Ctrl + / → Show keyboard shortcuts 4↑↓ → Navigate between blocks Block Types ----------- ### Text Blocks * Paragraphs * Headings (H1-H6) * Lists (Bulleted, Numbered) * Quotes * Callouts ### Rich Media * Images * Videos * Embeds * Files * Code blocks ### Special Blocks * Tables (Coming Soon) * Dividers * Custom components (Coming Soon) [PreviousCreating Pages](/en/docs/content-management/creating-pages) [NextFeatures](/en/docs/editor/features) --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs --- # Email Protection | Cloudflare Please enable cookies. Email Protection ================ You are unable to access this email address akiradocs.ai -------------------------------------------------------- The website from which you got to this page is protected by Cloudflare. Email addresses on that page have been hidden in order to keep them from being accessed by malicious bots. **You must enable Javascript in your browser in order to decode the e-mail address**. If you have a website and are interested in protecting it in a similar way, you can [sign up for Cloudflare](https://www.cloudflare.com/sign-up?utm_source=email_protection) . * [How does Cloudflare protect email addresses on website from spammers?](https://support.cloudflare.com/hc/en-us/articles/200170016-What-is-Email-Address-Obfuscation-) * [Can I sign up for Cloudflare?](https://support.cloudflare.com/hc/en-us/categories/200275218-Getting-Started) Cloudflare Ray ID: **8f9eef612c8bc9b9** • Your IP: Click to reveal 54.237.218.47 • Performance & security by [Cloudflare](https://www.cloudflare.com/5xx-error-landing) --- # Documentation | Akira Docs ### 404 - Page Not Found 404 AI Assistant says: Go HomeTry Again Redirecting in 10 seconds... Powered byAkiraDocs ---