GitHub - Cloud-Code-AI/AkiraDocs: Beautiful docs that write, translate, and optimize themselves

AkiraDocs

Beautiful docs that write, translate, and optimize themselves

If you find AkiraDocs useful, please consider giving it a star! ⭐️
Your support helps us continue improving the platform.

🚀 What is AkiraDocs?

AkiraDocs is a modern documentation platform that combines the power of AI with a Notion-like editing experience. Create, translate, and optimize your documentation automatically while maintaining complete control over the content. Perfect for teams who want to focus on their ideas rather than the complexities of documentation management.

📚 WebRAG Documentation Search

AkiraDocs implements a fully client-side RAG (Retrieval Augmented Generation) system that enables unlimited AI chat interactions without any API costs or rate limits.

How it Works

1. Offline Indexing: Documentation is processed and embedded during build time using GTE-small model
2. Browser-Based Components:
   • SQLite database (stored in browser) for vector search
   • Local embedding model for query processing
   • Local LLaMA model for response generation
   • All processing happens directly in the user's browser

Key Benefits

• ✨ No API Costs: Everything runs locally in the browser
• 🚀 Unlimited Chats: No rate limits or usage restrictions
• 🔒 Privacy-First: No data leaves the user's device
• ⚡ Low Latency: Direct local processing after initial model load

Technical Stack

• Embedding: sauravpanda/gte-small-onnx
• LLM: Llama-3.2-1B-Instruct
• Storage: sql.js-httpvfs for SQLite in browser

⚡️ Quick Deploy

Get started in seconds:

Or via CLI:

npx create-akiradocs <optional folder name>

🎯 Perfect For

• Developers: API docs, SDK guides, implementation examples
• Product Teams: User guides, release notes, tutorials
• Enterprises: Internal wikis, process documentation, knowledge bases

✨ Key Features

Notion-like Editor

Intuitive block-based interface with real-time preview

AI-Powered Content Generation

Automatically enhance your content with AI

Translation

Translate your content to multiple languages with AI

🔍 AI-Generated SEO Optimization

Automatically optimize your documentation for search engines with AI-driven SEO

• Improve discoverability and reach without manual SEO adjustments
• AI recommendations for keywords and metadata

🛠 Developer-Friendly

• Keep your existing Markdown/Git workflow
• Full Markdown/MDX support
• Easy custom component development
• SEO optimization out of the box

📝 Content Creator-Friendly

• Modern block-based WYSIWYG editor
• Real-time previews
• Rich media support
• Reusable content blocks

🌍 Going Global

Built-in AI-powered translation. Just add API keys:

{
  "translation": {
    "auto_translate": true,
    "provider": "anthropic",
    "targetLanguages": ["es", "fr", "de"]
  }
}

🤖 Upcoming Features

• AI-Powered Documentation Generation
  • Automatically generate comprehensive documentation from your codebase
  • AI-assisted content updates to keep your docs current with minimal effort
  • Intelligent suggestions for content improvements and expansions

🔄 Easy Migration (Coming Soon)

Import your existing docs:

npx akiradocs-migrate import --from=source --to=mydocs
# Supports: GitBook, Docusaurus, ReadTheDocs, Confluence, Notion

🤝 Join Our Community

• Live Demo
• Documentation
• Discord Community
• GitHub Discussions
• Join Waitlist for early access

📄 Licensing

• Open Source (MIT License)
• Commercial License available for enterprise features

Get Started • Live Demo • Enterprise Trial (Coming Q1 2025)