Skip to content

Cloud-Code-AI/AkiraDocs

Repository files navigation

AkiraDocs

Smart documentation platform with AI at its core

License: MIT License: Commercial PRs Welcome PRs Welcome

😟 Common Documentation Challenges

  • Developer Teams: "We want to keep using Markdown and Git..."
  • Content Teams: "We need a user-friendly editor..."
  • Technical Writers: "Managing multiple doc versions is a nightmare..."
  • Product Managers: "Our docs are always out of sync..."
  • Enterprise Leaders: "We need better documentation analytics..."

🎯 The AkiraDocs Solution

One platform that brings everyone's workflow together:

✓ Developers keep their Markdown/Git workflow
✓ Content teams get their block-based WYSIWYG editor
✓ Everyone stays in sync, automatically
✓ SEO-optimized documentation by default
✓ Multi-language support with AI-powered translations

Early Draft of AkiraDocs features

AkiraDocs First Draft

🎭 Perfect For Every Use Case

Developer Documentation

  • API References
  • SDK Guides
  • Technical Specifications
  • Implementation Examples
  • Architecture Docs

Product Documentation

  • User Guides
  • Feature Documentation
  • Release Notes
  • Tutorials
  • FAQs
  • Interactive Components
  • Embedded Media Blocks

Enterprise Knowledge

  • Internal Wikis
  • Process Documentation
  • Training Materials
  • Compliance Docs
  • Best Practices

🚀 Migrate Existing Docs in Minutes (Coming Soon)

Bring your existing documentation from anywhere:

# Migrate your docs with a single command
npx akiradocs-migrate import --from=source --to=mydocs

# Sources we support:
✓ Markdown/MDX files
✓ GitBook
✓ Docusaurus
✓ ReadTheDocs
✓ Confluence
✓ Notion

Migration Features

  • 🔄 Automatic content structuring
  • 🖼️ Image and asset handling
  • 🔗 URL redirects setup
  • 📱 Responsive optimization
  • 🔍 SEO meta generation

🎯 SEO-Optimized by Default

Every page is automatically optimized for search engines:

  • 📊 SEO-friendly URL structures
  • 🏷️ Auto-generated meta tags
  • 📱 Mobile-first indexing ready
  • 🔍 Structured data markup
  • 🚀 Blazing-fast performance
  • 🗺️ Automatic sitemap generation
  • 📈 Built-in SEO analytics

✍️ Modern Block-Based Editor

Write documentation the modern way:

  • 📝 Rich Text Blocks
  • 🖼️ Image & Media Blocks
  • 📊 Diagrams & Charts
  • 💻 Code Blocks with Syntax Highlighting
  • 📑 Collapsible Sections
  • 📋 Tables & Lists
  • 🔲 Custom Component Blocks
  • 🔄 Reusable Content Blocks

🌐 Powerful Language Support

Reach a global audience effortlessly:

  • 🔄 AI-powered translation suggestions
  • 📝 Side-by-side translation editor
  • 🔍 Translation memory & glossaries
  • 🌍 100+ languages supported
  • 📊 Translation progress tracking
  • 🔄 Automatic content sync across languages
  • 📱 Right-to-left (RTL) support
  • 🎯 Language-specific SEO optimization

🚀 Get Started

npx create-akiradocs@latest mydocs

💪 Why Choose AkiraDocs?

  • For Developers

    • Keep your existing Git workflow
    • Full Markdown/MDX support
    • Custom component development
    • API-first architecture
  • For Content Teams

    • Modern WYSIWYG editor
    • Real-time previews
    • No coding required
    • Version control made easy
  • For Enterprise

    • SSO/SAML integration
    • Audit logs
    • Custom deployment options
    • Priority support

📄 Licensing

  • MIT License: Free for open source and personal projects except for enterprise features (see below)
  • Commercial License: Enterprise features and support

🤝 Join Our Community


Get StartedLive DemoEnterprise Trial (Coming Q1 2025)

Releases

No releases published

Packages

No packages published