Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit 7f9a041

Browse files
SwapnilChandSwapnilChand
committed
Combine Project Explorer and Editor into a Single Interface (#198)
1 parent 1056b6d commit 7f9a041

File tree

301 files changed

+45226
-3825
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

301 files changed

+45226
-3825
lines changed

‎packages/create-app/.eslintrc.json‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,4 @@
11
{
2-
"extends": [
3-
"eslint:recommended",
4-
"plugin:@typescript-eslint/recommended",
5-
"plugin:prettier/recommended",
6-
"next"
7-
],
8-
"parser": "@typescript-eslint/parser",
9-
// Remove the plugins array since @typescript-eslint is already included via the extends
2+
"extends": "next",
103
"root": true
11-
}
4+
}

‎packages/create-app/.gitignore‎

Lines changed: 132 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,132 @@
1-
node_modules/
2-
dist/
3-
template/
4-
*.log
5-
.DS_Store
6-
template/
1+
2+
<p align="center">
3+
<h1 align="center">AkiraDocs</h1>
4+
</p>
5+
6+
<p align="center">
7+
<a href="https://discord.gg/zvYZukgeH2">
8+
<img src="https://img.shields.io/badge/Join_Our_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Join Our Discord">
9+
</a>
10+
</p>
11+
12+
<p align="center">
13+
<h4 align="center"><strong>Beautiful docs that write, translate, and optimize themselves</strong></h4>
14+
</p>
15+
16+
<p align="center">
17+
<img src="gifs/star_the_repo.gif" alt="Star the Repo" width="100%">
18+
</p>
19+
20+
<p align="center">
21+
If you find AkiraDocs useful, please consider giving it a star! ⭐️<br>
22+
Your support helps us continue improving the platform.
23+
</p>
24+
25+
26+
<p align="center">
27+
<a href="https://demo.akiradocs.ai">
28+
<img src="https://img.shields.io/badge/Try_Demo-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Live Demo">
29+
</a>
30+
<a href="https://forms.gle/KunU4BGhToH4NJ1t7">
31+
<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">
32+
</a>
33+
</p>
34+
35+
## 🚀 What is AkiraDocs?
36+
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.
37+
38+
39+
## ⚡️ Quick Deploy
40+
Get started in seconds:
41+
42+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template)
43+
44+
Or via CLI:
45+
```bash
46+
npx create-akiradocs <optional folder name>
47+
```
48+
49+
![AkiraDocs installation](gifs/install_akiradocs.gif)
50+
51+
## 🎯 Perfect For
52+
- **Developers**: API docs, SDK guides, implementation examples
53+
- **Product Teams**: User guides, release notes, tutorials
54+
- **Enterprises**: Internal wikis, process documentation, knowledge bases
55+
56+
## ✨ Key Features
57+
58+
### Notion-like Editor
59+
Intuitive block-based interface with real-time preview
60+
61+
![AkiraDocs editor](gifs/akiradocs_editor.gif)
62+
63+
### AI-Powered Content Generation
64+
Automatically enhance your content with AI
65+
66+
![AkiraDocs AI](gifs/ai_rewrites.gif)
67+
68+
### Translation
69+
Translate your content to multiple languages with AI
70+
71+
![AkiraDocs Translation](gifs/translate.gif)
72+
73+
### 🔍 AI-Generated SEO Optimization
74+
Automatically optimize your documentation for search engines with AI-driven SEO
75+
- Improve discoverability and reach without manual SEO adjustments
76+
- AI recommendations for keywords and metadata
77+
78+
### 🛠 Developer-Friendly
79+
- Keep your existing Markdown/Git workflow
80+
- Full Markdown/MDX support
81+
- Easy custom component development
82+
- SEO optimization out of the box
83+
84+
### 📝 Content Creator-Friendly
85+
- Modern block-based WYSIWYG editor
86+
- Real-time previews
87+
- Rich media support
88+
- Reusable content blocks
89+
90+
91+
## 🌍 Going Global
92+
Built-in AI-powered translation. Just add API keys:
93+
```json
94+
{
95+
"translation": {
96+
"auto_translate": true,
97+
"provider": "anthropic",
98+
"targetLanguages": ["es", "fr", "de"]
99+
}
100+
}
101+
```
102+
103+
### 🤖 Upcoming Features
104+
- **AI-Powered Documentation Generation**
105+
- Automatically generate comprehensive documentation from your codebase
106+
- AI-assisted content updates to keep your docs current with minimal effort
107+
- Intelligent suggestions for content improvements and expansions
108+
109+
110+
## 🔄 Easy Migration (Coming Soon)
111+
Import your existing docs:
112+
```bash
113+
npx akiradocs-migrate import --from=source --to=mydocs
114+
# Supports: GitBook, Docusaurus, ReadTheDocs, Confluence, Notion
115+
```
116+
117+
## 🤝 Join Our Community
118+
- [Live Demo](https://demo.akiradocs.ai)
119+
- [Documentation](https://docs.akiradocs.com)
120+
- [Discord Community](https://discord.gg/zvYZukgeH2)
121+
- [GitHub Discussions](https://github.com/Cloud-Code-AI/akiradocs/discussions)
122+
- [Join Waitlist](https://forms.gle/KunU4BGhToH4NJ1t7) for early access
123+
124+
## 📄 Licensing
125+
- Open Source (MIT License)
126+
- Commercial License available for enterprise features
127+
128+
---
129+
130+
[Get Started](https://docs.akiradocs.ai/quickstart) •
131+
[Live Demo](https://demo.akiradocs.ai) •
132+
[Enterprise Trial](https://akiradocs.com/enterprise) (Coming Q1 2025)

‎packages/create-app/README.md‎

Lines changed: 106 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,132 @@
1-
# create-akiradocs
21

3-
Create Akira Docs documentation sites with one command.
2+
<p align="center">
3+
<h1 align="center">AkiraDocs</h1>
4+
</p>
45

5-
## Usage
6+
<p align="center">
7+
<a href="https://discord.gg/zvYZukgeH2">
8+
<img src="https://img.shields.io/badge/Join_Our_Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Join Our Discord">
9+
</a>
10+
</p>
11+
12+
<p align="center">
13+
<h4 align="center"><strong>Beautiful docs that write, translate, and optimize themselves</strong></h4>
14+
</p>
15+
16+
<p align="center">
17+
<img src="gifs/star_the_repo.gif" alt="Star the Repo" width="100%">
18+
</p>
19+
20+
<p align="center">
21+
If you find AkiraDocs useful, please consider giving it a star! ⭐️<br>
22+
Your support helps us continue improving the platform.
23+
</p>
24+
25+
26+
<p align="center">
27+
<a href="https://demo.akiradocs.ai">
28+
<img src="https://img.shields.io/badge/Try_Demo-4285F4?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Live Demo">
29+
</a>
30+
<a href="https://forms.gle/KunU4BGhToH4NJ1t7">
31+
<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">
32+
</a>
33+
</p>
34+
35+
## 🚀 What is AkiraDocs?
36+
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.
37+
38+
39+
## ⚡️ Quick Deploy
40+
Get started in seconds:
41+
42+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template)
43+
44+
Or via CLI:
645
```bash
7-
npx create-akiradocs mydocs
46+
npx create-akiradocs <optional folder name>
847
```
948

10-
## Features
49+
![AkiraDocs installation](gifs/install_akiradocs.gif)
1150

12-
- 📝 Block-based content editing
13-
- 🎨 Customizable themes
14-
- 🔍 AI-powered search
15-
- 📱 Responsive design
16-
- ⚡ Next.js based
17-
- 🎯 SEO optimized
51+
## 🎯 Perfect For
52+
- **Developers**: API docs, SDK guides, implementation examples
53+
- **Product Teams**: User guides, release notes, tutorials
54+
- **Enterprises**: Internal wikis, process documentation, knowledge bases
1855

19-
## Requirements
56+
## ✨ Key Features
2057

21-
- Node.js 16 or later
58+
### Notion-like Editor
59+
Intuitive block-based interface with real-time preview
2260

23-
## Creating a Project
61+
![AkiraDocs editor](gifs/akiradocs_editor.gif)
2462

25-
1. Create a new project:
26-
```bash
27-
npx create-akiradocs@latest my-docs
28-
```
63+
### AI-Powered Content Generation
64+
Automatically enhance your content with AI
2965

30-
2. Navigate to the project:
31-
```bash
32-
cd my-docs
33-
```
66+
![AkiraDocs AI](gifs/ai_rewrites.gif)
3467

35-
3. Install dependencies:
36-
```bash
37-
npm install
38-
```
68+
### Translation
69+
Translate your content to multiple languages with AI
3970

40-
4. Start the development server:
41-
```bash
42-
npm run dev
43-
```
71+
![AkiraDocs Translation](gifs/translate.gif)
4472

45-
5. Open [http://localhost:3000](http://localhost:3000) in your browser.
73+
### 🔍 AI-Generated SEO Optimization
74+
Automatically optimize your documentation for search engines with AI-driven SEO
75+
- Improve discoverability and reach without manual SEO adjustments
76+
- AI recommendations for keywords and metadata
4677

47-
## Updating a Project
78+
### 🛠 Developer-Friendly
79+
- Keep your existing Markdown/Git workflow
80+
- Full Markdown/MDX support
81+
- Easy custom component development
82+
- SEO optimization out of the box
4883

49-
To update an existing Akira Docs site to the latest version:
84+
### 📝 Content Creator-Friendly
85+
- Modern block-based WYSIWYG editor
86+
- Real-time previews
87+
- Rich media support
88+
- Reusable content blocks
5089

51-
```bash
52-
npx update-akiradocs
53-
```
5490

55-
This will update your project while preserving your content and configuration files.
91+
## 🌍 Going Global
92+
Built-in AI-powered translation. Just add API keys:
93+
```json
94+
{
95+
"translation": {
96+
"auto_translate": true,
97+
"provider": "anthropic",
98+
"targetLanguages": ["es", "fr", "de"]
99+
}
100+
}
56101
```
57102

58-
Now users can update their existing Akira Docs sites using:
59-
```bash
60-
npx update-akiradocs
61-
```
103+
### 🤖 Upcoming Features
104+
- **AI-Powered Documentation Generation**
105+
- Automatically generate comprehensive documentation from your codebase
106+
- AI-assisted content updates to keep your docs current with minimal effort
107+
- Intelligent suggestions for content improvements and expansions
62108

63-
This implementation:
64-
1. Preserves user content by ignoring `_contents`, `contents`, and `akiradocs.config.json`
65-
2. Updates all other files with the latest template
66-
3. Provides a simple command-line interface
67-
4. Shows progress with a spinner and clear success/error messages
68-
5. Maintains the same code style and structure as the existing codebase
69109

70-
The update command will copy the latest template files while preserving user-specific content and configuration files.
110+
## 🔄 Easy Migration (Coming Soon)
111+
Import your existing docs:
112+
```bash
113+
npx akiradocs-migrate import --from=source --to=mydocs
114+
# Supports: GitBook, Docusaurus, ReadTheDocs, Confluence, Notion
115+
```
71116

72-
## Documentation
117+
## 🤝 Join Our Community
118+
- [Live Demo](https://demo.akiradocs.ai)
119+
- [Documentation](https://docs.akiradocs.com)
120+
- [Discord Community](https://discord.gg/zvYZukgeH2)
121+
- [GitHub Discussions](https://github.com/Cloud-Code-AI/akiradocs/discussions)
122+
- [Join Waitlist](https://forms.gle/KunU4BGhToH4NJ1t7) for early access
73123

74-
For detailed documentation, visit [docs.akiradocs.com](https://docs.akiradocs.com)
124+
## 📄 Licensing
125+
- Open Source (MIT License)
126+
- Commercial License available for enterprise features
75127

76-
## License
128+
---
77129

78-
MIT
130+
[Get Started](https://docs.akiradocs.ai/quickstart) •
131+
[Live Demo](https://demo.akiradocs.ai) •
132+
[Enterprise Trial](https://akiradocs.com/enterprise) (Coming Q1 2025)

0 commit comments

Comments
 (0)