Combine Project Explorer and Editor into a Single Interface (#198)

Cloud-Code-AI · Dec 10, 2024 · 7f9a041 · 7f9a041
1 parent 1056b6d
commit 7f9a041
Show file tree

Hide file tree

Showing 301 changed files with 45,226 additions and 3,825 deletions.
diff --git a/packages/create-app/.eslintrc.json b/packages/create-app/.eslintrc.json
@@ -1,11 +1,4 @@
 {
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:prettier/recommended",
-    "next"
-  ],
-  "parser": "@typescript-eslint/parser",
-  // Remove the plugins array since @typescript-eslint is already included via the extends
+  "extends": "next",
   "root": true
-}
+}
diff --git a/packages/create-app/.gitignore b/packages/create-app/.gitignore
@@ -1,6 +1,132 @@
-node_modules/
-dist/
-template/
-*.log
-.DS_Store
-template/
+
+<p align="center">
+  <h1 align="center">AkiraDocs</h1>
+</p>
+
+<p align="center">
+  <a href="https://discord.gg/zvYZukgeH2">
+    <img src="https://img.shields.io/badge/Join_Our_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Join Our Discord">
+  </a>
+</p>
+
+<p align="center">
+  <h4 align="center"><strong>Beautiful docs that write, translate, and optimize themselves</strong></h4>
+</p>
+
+<p align="center">
+  <img src="gifs/star_the_repo.gif" alt="Star the Repo" width="100%">
+</p>
+
+<p align="center">
+  If you find AkiraDocs useful, please consider giving it a star! ⭐️<br>
+  Your support helps us continue improving the platform.
+</p>
+
+
+<p align="center">
+  <a href="https://demo.akiradocs.ai">
+    <img src="https://img.shields.io/badge/Try_Demo-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Live Demo">
+  </a>
+  <a href="https://forms.gle/KunU4BGhToH4NJ1t7">
+    <img src="https://img.shields.io/badge/Join_Waitlist_For_Cloud_Hosting-FF6B6B?style=for-the-badge&logo=googleforms&logoColor=white" alt="Join Waitlist for Cloud Hosting">
+  </a>
+</p>
+
+## 🚀 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.
+
+
+## ⚡️ Quick Deploy
+Get started in seconds:
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template)
+
+Or via CLI:
+```bash
+npx create-akiradocs <optional folder name>
+```
+
+![AkiraDocs installation](gifs/install_akiradocs.gif)
+
+## 🎯 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
+
+![AkiraDocs editor](gifs/akiradocs_editor.gif)
+
+### AI-Powered Content Generation
+Automatically enhance your content with AI
+
+![AkiraDocs AI](gifs/ai_rewrites.gif)
+
+### Translation
+Translate your content to multiple languages with AI
+
+![AkiraDocs Translation](gifs/translate.gif)
+
+### 🔍 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:
+```json
+{
+  "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:
+```bash
+npx akiradocs-migrate import --from=source --to=mydocs
+# Supports: GitBook, Docusaurus, ReadTheDocs, Confluence, Notion
+```
+
+## 🤝 Join Our Community
+- [Live Demo](https://demo.akiradocs.ai)
+- [Documentation](https://docs.akiradocs.com)
+- [Discord Community](https://discord.gg/zvYZukgeH2)
+- [GitHub Discussions](https://github.com/Cloud-Code-AI/akiradocs/discussions)
+- [Join Waitlist](https://forms.gle/KunU4BGhToH4NJ1t7) for early access
+
+## 📄 Licensing
+- Open Source (MIT License)
+- Commercial License available for enterprise features
+
+---
+
+[Get Started](https://docs.akiradocs.ai/quickstart) •
+[Live Demo](https://demo.akiradocs.ai) •
+[Enterprise Trial](https://akiradocs.com/enterprise) (Coming Q1 2025)
diff --git a/packages/create-app/README.md b/packages/create-app/README.md
@@ -1,78 +1,132 @@
-# create-akiradocs
 
-Create Akira Docs documentation sites with one command.
+<p align="center">
+  <h1 align="center">AkiraDocs</h1>
+</p>
 
-## Usage 
+<p align="center">
+  <a href="https://discord.gg/zvYZukgeH2">
+    <img src="https://img.shields.io/badge/Join_Our_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Join Our Discord">
+  </a>
+</p>
+
+<p align="center">
+  <h4 align="center"><strong>Beautiful docs that write, translate, and optimize themselves</strong></h4>
+</p>
+
+<p align="center">
+  <img src="gifs/star_the_repo.gif" alt="Star the Repo" width="100%">
+</p>
+
+<p align="center">
+  If you find AkiraDocs useful, please consider giving it a star! ⭐️<br>
+  Your support helps us continue improving the platform.
+</p>
+
+
+<p align="center">
+  <a href="https://demo.akiradocs.ai">
+    <img src="https://img.shields.io/badge/Try_Demo-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Live Demo">
+  </a>
+  <a href="https://forms.gle/KunU4BGhToH4NJ1t7">
+    <img src="https://img.shields.io/badge/Join_Waitlist_For_Cloud_Hosting-FF6B6B?style=for-the-badge&logo=googleforms&logoColor=white" alt="Join Waitlist for Cloud Hosting">
+  </a>
+</p>
+
+## 🚀 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.
+
+
+## ⚡️ Quick Deploy
+Get started in seconds:
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template)
+
+Or via CLI:
 ```bash
-npx create-akiradocs mydocs
+npx create-akiradocs <optional folder name>
 ```
 
-## Features
+![AkiraDocs installation](gifs/install_akiradocs.gif)
 
-- 📝 Block-based content editing
-- 🎨 Customizable themes
-- 🔍 AI-powered search
-- 📱 Responsive design
-- ⚡ Next.js based
-- 🎯 SEO optimized
+## 🎯 Perfect For
+- **Developers**: API docs, SDK guides, implementation examples
+- **Product Teams**: User guides, release notes, tutorials
+- **Enterprises**: Internal wikis, process documentation, knowledge bases
 
-## Requirements
+## ✨ Key Features
 
-- Node.js 16 or later
+### Notion-like Editor
+Intuitive block-based interface with real-time preview
 
-## Creating a Project
+![AkiraDocs editor](gifs/akiradocs_editor.gif)
 
-1. Create a new project:
-   ```bash
-   npx create-akiradocs@latest my-docs
-   ```
+### AI-Powered Content Generation
+Automatically enhance your content with AI
 
-2. Navigate to the project:
-   ```bash
-   cd my-docs
-   ```
+![AkiraDocs AI](gifs/ai_rewrites.gif)
 
-3. Install dependencies:
-   ```bash
-   npm install
-   ```
+### Translation
+Translate your content to multiple languages with AI
 
-4. Start the development server:
-   ```bash
-   npm run dev
-   ```
+![AkiraDocs Translation](gifs/translate.gif)
 
-5. Open [http://localhost:3000](http://localhost:3000) in your browser.
+### 🔍 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
 
-## Updating a Project
+### 🛠 Developer-Friendly
+- Keep your existing Markdown/Git workflow
+- Full Markdown/MDX support
+- Easy custom component development
+- SEO optimization out of the box
 
-To update an existing Akira Docs site to the latest version:
+### 📝 Content Creator-Friendly
+- Modern block-based WYSIWYG editor
+- Real-time previews
+- Rich media support
+- Reusable content blocks
 
-```bash
-npx update-akiradocs
-```
 
-This will update your project while preserving your content and configuration files.
+## 🌍 Going Global
+Built-in AI-powered translation. Just add API keys:
+```json
+{
+  "translation": {
+    "auto_translate": true,
+    "provider": "anthropic",
+    "targetLanguages": ["es", "fr", "de"]
+  }
+}
 ```
 
-Now users can update their existing Akira Docs sites using:
-```bash
-npx update-akiradocs
-```
+### 🤖 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
 
-This implementation:
-1. Preserves user content by ignoring `_contents`, `contents`, and `akiradocs.config.json`
-2. Updates all other files with the latest template
-3. Provides a simple command-line interface
-4. Shows progress with a spinner and clear success/error messages
-5. Maintains the same code style and structure as the existing codebase
 
-The update command will copy the latest template files while preserving user-specific content and configuration files.
+## 🔄 Easy Migration (Coming Soon)
+Import your existing docs:
+```bash
+npx akiradocs-migrate import --from=source --to=mydocs
+# Supports: GitBook, Docusaurus, ReadTheDocs, Confluence, Notion
+```
 
-## Documentation
+## 🤝 Join Our Community
+- [Live Demo](https://demo.akiradocs.ai)
+- [Documentation](https://docs.akiradocs.com)
+- [Discord Community](https://discord.gg/zvYZukgeH2)
+- [GitHub Discussions](https://github.com/Cloud-Code-AI/akiradocs/discussions)
+- [Join Waitlist](https://forms.gle/KunU4BGhToH4NJ1t7) for early access
 
-For detailed documentation, visit [docs.akiradocs.com](https://docs.akiradocs.com)
+## 📄 Licensing
+- Open Source (MIT License)
+- Commercial License available for enterprise features
 
-## License
+---
 
-MIT
+[Get Started](https://docs.akiradocs.ai/quickstart) •
+[Live Demo](https://demo.akiradocs.ai) •
+[Enterprise Trial](https://akiradocs.com/enterprise) (Coming Q1 2025)