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

Commit 7aa8ddb

Browse files
authored
Merge pull request #154 from Cloud-Code-AI/153-experiment-static-build-for-pages
feat: added static build for docs pages
2 parents 7e5e36c + c74ee93 commit 7aa8ddb

37 files changed

+632
-1224
lines changed

docs/README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
<h1 align="center">AkiraDocs</h1>
44
</p>
55

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+
612
<p align="center">
713
<h4 align="center"><strong>Beautiful docs that write, translate, and optimize themselves</strong></h4>
814
</p>
@@ -40,15 +46,32 @@ Or via CLI:
4046
npx create-akiradocs <optional folder name>
4147
```
4248

49+
![AkiraDocs installation](gifs/install_akiradocs.gif)
50+
4351
## 🎯 Perfect For
4452
- **Developers**: API docs, SDK guides, implementation examples
4553
- **Product Teams**: User guides, release notes, tutorials
4654
- **Enterprises**: Internal wikis, process documentation, knowledge bases
4755

4856
## ✨ Key Features
4957

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+
5073
### 🔍 AI-Generated SEO Optimization
51-
- Automatically optimize your documentation for search engines with AI-driven SEO
74+
Automatically optimize your documentation for search engines with AI-driven SEO
5275
- Improve discoverability and reach without manual SEO adjustments
5376
- AI recommendations for keywords and metadata
5477

@@ -64,11 +87,6 @@ npx create-akiradocs <optional folder name>
6487
- Rich media support
6588
- Reusable content blocks
6689

67-
### 🏢 Enterprise-Ready
68-
- SSO/SAML integration
69-
- Audit logs
70-
- Custom deployment options
71-
- Version control
7290

7391
## 🌍 Going Global
7492
Built-in AI-powered translation. Just add API keys:

docs/akiradocs.config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"url": "https://docs.akiradocs.com",
32
"site": {
43
"title": "Akira Docs",
5-
"description": "Next-gen documentation powered by AI"
4+
"description": "Next-gen documentation powered by AI",
5+
"url": "https://docs.akiradocs.com"
66
},
77
"branding": {
88
"logo": {

docs/example.env

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ANTHROPIC_API_KEY=

docs/gifs/ai_rewrites.gif

950 KB
Loading

docs/gifs/akiradocs_editor.gif

585 KB
Loading

docs/gifs/install_akiradocs.gif

342 KB
Loading

docs/gifs/translate.gif

3.26 MB
Loading

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "akiradocs",
3-
"version": "1.0.37",
3+
"version": "1.0.38",
44
"private": true,
55
"scripts": {
66
"translate": "npm run compile && node scripts/translate.js",

0 commit comments

Comments
 (0)