diff --git a/docs/README.md b/docs/README.md index c40784b..80c0435 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,6 +3,12 @@

AkiraDocs

+

+ + Join Our Discord + +

+

Beautiful docs that write, translate, and optimize themselves

@@ -40,6 +46,8 @@ Or via CLI: npx create-akiradocs ``` +![AkiraDocs installation](gifs/install_akiradocs.gif) + ## 🎯 Perfect For - **Developers**: API docs, SDK guides, implementation examples - **Product Teams**: User guides, release notes, tutorials @@ -47,8 +55,23 @@ npx create-akiradocs ## ✨ 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 +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 @@ -64,11 +87,6 @@ npx create-akiradocs - Rich media support - Reusable content blocks -### 🏒 Enterprise-Ready -- SSO/SAML integration -- Audit logs -- Custom deployment options -- Version control ## 🌍 Going Global Built-in AI-powered translation. Just add API keys: diff --git a/docs/akiradocs.config.json b/docs/akiradocs.config.json index f1d5b4b..d1f8bb9 100644 --- a/docs/akiradocs.config.json +++ b/docs/akiradocs.config.json @@ -1,8 +1,8 @@ { - "url": "https://docs.akiradocs.com", "site": { "title": "Akira Docs", - "description": "Next-gen documentation powered by AI" + "description": "Next-gen documentation powered by AI", + "url": "https://docs.akiradocs.com" }, "branding": { "logo": { diff --git a/docs/example.env b/docs/example.env new file mode 100644 index 0000000..80a79e6 --- /dev/null +++ b/docs/example.env @@ -0,0 +1 @@ +ANTHROPIC_API_KEY= \ No newline at end of file diff --git a/docs/gifs/ai_rewrites.gif b/docs/gifs/ai_rewrites.gif new file mode 100644 index 0000000..3e8e952 Binary files /dev/null and b/docs/gifs/ai_rewrites.gif differ diff --git a/docs/gifs/akiradocs_editor.gif b/docs/gifs/akiradocs_editor.gif new file mode 100644 index 0000000..0004d2c Binary files /dev/null and b/docs/gifs/akiradocs_editor.gif differ diff --git a/docs/gifs/install_akiradocs.gif b/docs/gifs/install_akiradocs.gif new file mode 100644 index 0000000..ca47cdb Binary files /dev/null and b/docs/gifs/install_akiradocs.gif differ diff --git a/docs/gifs/translate.gif b/docs/gifs/translate.gif new file mode 100644 index 0000000..9a99bda Binary files /dev/null and b/docs/gifs/translate.gif differ diff --git a/docs/package.json b/docs/package.json index 81e7833..d6c7a0e 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,6 +1,6 @@ { "name": "akiradocs", - "version": "1.0.37", + "version": "1.0.38", "private": true, "scripts": { "translate": "npm run compile && node scripts/translate.js", diff --git a/docs/public/context/en_docs.txt b/docs/public/context/en_docs.txt index 0074d0b..b1c2505 100644 --- a/docs/public/context/en_docs.txt +++ b/docs/public/context/en_docs.txt @@ -1,36 +1,12 @@ [Document: docs/introduction.json] -Title: Introduction to AkiraDocs -AkiraDocs is a next-generation documentation platform that combines the power of AI with an intuitive content management system. It's designed to transform your documentation workflow from days to minutes. -Why AkiraDocs? -Documentation is often a challenge for teams: -Developers want to keep using Markdown and Git -Content teams need user-friendly editors -Technical writers struggle with version management -Product managers deal with out-of-sync documentation -Enterprise leaders need better analytics -AkiraDocs solves these challenges by providing a unified platform that brings everyone's workflow together. -Core Benefits -Universal Workflow: Developers keep their Markdown/Git workflow while content teams get a block-based WYSIWYG editor -AI-Powered: Automatic content updates, translations, and optimizations -SEO-Optimized: Documentation that ranks well by default -Multi-Language Support: AI-powered translations with context awareness -Enterprise-Ready: SSO/SAML integration, audit logs, and custom deployment options -Who Is It For? -Developer Documentation -API documentation -SDK guides -Technical specifications -Implementation guides -Product Documentation -User guides -Feature documentation -Release notes -FAQs -Enterprise Documentation -Internal knowledge bases -Process documentation -Compliance documentation -Training materials +Title: Introduction +Akira Docs is a modern documentation platform that combines the power of AI with an intuitive block-based content system. This guide will help you understand the core concepts and features. +Key Features +AI-powered search +Block-based content editing +Responsive design +Customizable themes +Markdown support ------------- [Document: articles/welcome.json] Title: Welcome to Akira Doc @@ -90,390 +66,6 @@ ai_assistant: Next Steps Explore our [Advanced AI Features](/advanced-ai-features) guide to learn more about specialized use cases and integration possibilities. ------------- -[Document: docs/seo-and-performance/sitemap-generation.json] -Title: Automatic Sitemap Generation -Learn how AkiraDocs automatically generates and manages your documentation sitemap. -Overview -AkiraDocs automatically generates a sitemap.xml file during the build process, ensuring search engines can efficiently crawl your documentation. -Generated Sitemap Structure -Example Output -Code example: - - - - https://yourdocs.com/ - 2024-11-26 - weekly - 1.0 - - - https://yourdocs.com/docs/getting-started - 2024-11-26 - weekly - 0.8 - - -------------- -[Document: docs/seo-and-performance/robot-txt.json] -Title: Robots.txt Configuration -The robots.txt file is automatically generated during the build process and can be found in the `public` folder of your project. -Default Configuration -Basic robots.txt -Code example: -User-agent: * -Allow: / -Sitemap: https://docs.akiradocs.com/sitemap.xml - -# Private sections -Disallow: /admin/ -Disallow: /private/ -------------- -[Document: docs/internationalization/setup.json] -Title: Setting Up Internationalization -Configure AkiraDocs for multiple languages with AI-powered translation support. -Quick Setup -Basic Configuration -Add language settings to `akiradocs.config.json`: -Code example: -{ - "localization": { - "defaultLocale": "en", - "fallbackLocale": "en", - "locales": [ - { - "code": "en", - "name": "English", - "flag": "οΏ½πŸ‡Έ" - }, - { - "code": "es", - "name": "EspaΓ±ol", - "flag": "πŸ‡ͺπŸ‡Έ" - }, - { - "code": "fr", - "name": "FranΓ§ais", - "flag": "πŸ‡«πŸ‡·" - } - ] - }, - "translation": { - "auto_translate": true, - "provider": "anthropic", - "targetLanguages": ["es", "fr", "de"], - "excludedPaths": ["_meta.json"] - } -} -Directory Structure -Code example: -docs/ -β”œβ”€β”€ _contents/ -β”‚ β”œβ”€β”€ en/ # Source language -β”‚ β”‚ └── docs/ -β”‚ β”œβ”€β”€ es/ # Spanish translation -β”‚ β”‚ └── docs/ -β”‚ └── fr/ # French translation -β”‚ └── docs/ -Configuration Options -Language Settings -`defaultLocale`: Primary content language -`fallbackLocale`: Fallback when translation missing -`locales`: Available language configurations -Translation Settings -`auto_translate`: Enable/disable automatic translation -`provider`: AI translation provider -`targetLanguages`: Languages to translate into -`excludedPaths`: Files to skip during translation -------------- -[Document: docs/internationalization/managing-translation.json] -Title: Managing Translations -Learn how to effectively manage and maintain translated content in AkiraDocs. -Translation Workflow -Automatic Translation -1. Create content in source language -2. Enable auto-translation in config -3. Build/deploy to generate translations -4. Review and refine translations -Manual Translation -1. Create language-specific directories -2. Copy source content -3. Translate manually -4. Update metadata -Content Organization -File Structure -Code example: -_contents/ -β”œβ”€β”€ en/ -β”‚ └── docs/ -β”‚ β”œβ”€β”€ intro.md -β”‚ └── guide.md -β”œβ”€β”€ es/ -β”‚ └── docs/ -β”‚ β”œβ”€β”€ intro.md -β”‚ └── guide.md -└── fr/ - └── docs/ - β”œβ”€β”€ intro.md - └── guide.md -Quality Control -Review Process -1. AI Translation -2. Human Review -3. Technical Verification -4. Publication -Version Control -Track changes across languages -Maintain synchronization -Handle updates efficiently -------------- -[Document: docs/internationalization/ai-translation.json] -Title: AI-Powered Translation -Guide to using AkiraDocs' AI translation capabilities. -Setup -Configuration -Code example: -{ - "translation": { - "auto_translate": true, - "provider": "anthropic", - "model": "claude-3-sonnet-20240229", - "targetLanguages": ["es", "fr", "de"], - "excludedPaths": ["_meta.json"] - } -} -API Setup -Code example: -ANTHROPIC_API_KEY=your_api_key -Features -Automatic Translation -Content translation during build -Context-aware translations -Technical term preservation -Format maintenance -------------- -[Document: docs/installation/troubleshooting.json] -Title: Troubleshooting Guide -Common issues and their solutions when setting up AkiraDocs. -Common Installation Issues -Node.js Version Mismatch -Problem: Error about Node.js version compatibility -Code example: -Error: The engine "node" is incompatible with this module -Solution: -1. Check your Node.js version: -Code example: -node --version -2. Install the correct version (16.x or higher) -3. Use nvm to manage Node.js versions: -Code example: -nvm install 20 -nvm use 20 -Dependencies Installation Failed -Problem: npm install fails with errors -Solution: -1. Clear npm cache: -Code example: -npm cache clean --force -2. Delete node_modules and package-lock.json: -Code example: -rm -rf node_modules package-lock.json -npm install -Build Issues -Build Fails -Problem: `npm run build` fails -Solution: -1. Check for TypeScript errors: -Code example: -npm run type-check -2. Verify environment variables are set correctly -3. Clear next.js cache: -Code example: -rm -rf .next -Static Export Issues -Problem: Static export fails with dynamic routes -Solution: -1. Configure `next.config.js`: -Code example: -module.exports = { - output: 'export', - images: { - unoptimized: true - } -} -Translation Issues -AI Translation Not Working -Problem: Automatic translation fails -Solution: -1. Verify API keys are set correctly -2. Check translation configuration: -Code example: -{ - "translation": { - "auto_translate": true, - "provider": "anthropic", - "targetLanguages": ["es", "fr", "de"] - } -} -Content Issues -Content Not Updating -Problem: Changes to content files not reflecting -Solution: -Content changes are built on build time. If you are using the local development server, you need to restart the server after making changes. -1. Clear the cache: -Code example: -npm run clean -2. Restart the development server -3. Check file permissions -Deployment Issues -Vercel Deployment Failed -Problem: Deployment to Vercel fails -Solution: -1. Check build logs -2. Verify environment variables are set in Vercel dashboard -3. Ensure all dependencies are listed in package.json -Getting Help -If you're still experiencing issues: -1. Check our [GitHub Issues](https://github.com/Cloud-Code-AI/Akiradocs/issues) -2. Join our [Discord Community](https://discord.gg/zvYZukgeH2) -3. Contact [Support](mailto:saurav.panda@akiradocs.ai) -------------- -[Document: docs/installation/setup.json] -Title: Detailed Installation Guide -Complete guide to installing AkiraDocs in different environments. -Prerequisites -Ensure your system meets the [requirements](../getting-started/requirements.md) before proceeding. -Installation Methods -1. Local Development Setup -1. Create New Project -Code example: -npx create-akiradocs@latest my-docs-site -cd my-docs-site -2. Install Dependencies -Dependencies are automatically installed during project creation. If you need to reinstall: -Code example: -npm install -3. Create Environment File -The environment file is created automatically. You can modify it at `.env.local` -4. Start Development Server -Code example: -npm run dev -5. Update AkiraDocs -To update an existing installation to the latest version: -Code example: -npx create-akiradocs@latest update -3. Cloud Platform Deployment -Vercel -1. Fork the repository -2. Connect to Vercel -3. Configure environment variables -4. Deploy -Other Platforms -AWS Amplify (Coming Soon) -Netlify (Coming Soon) -Digital Ocean (Coming Soon) -Custom server (Coming Soon) -Post-Installation Steps -1. Verify Installation -Code example: -npm run build -npm run start -2. Configure Git Integration -Code example: -git remote add origin your-repository-url -3. Setup Content Directory -Code example: -mkdir -p docs/_contents/en -Environment-Specific Configurations -Development -Code example: -NODE_ENV=development -DEBUG=true -Production -Code example: -NODE_ENV=production -DEBUG=false -Testing -Code example: -NODE_ENV=test -TEST_MODE=true -------------- -[Document: docs/installation/configuration.json] -Title: Configuration Guide -Complete guide to configuring your AkiraDocs installation. -Core Configuration -Site Configuration -Edit `akiradocs.config.json`: -Code example: -{ - "url": "https://docs.akiradocs.com", - "site": { - "title": "Your Docs", - "description": "Your documentation description" - }, - "branding": { - "logo": { - "path": "/your_logo.svg", - "width": 120, - "height": 30, - "show": true - }, - "favicon": { - "path": "/favicon.png", - "show": true - } - } -} -Navigation Setup -Code example: -{ - "navigation": { - "header": { - "items": [ - { "label": "Docs", "href": "/docs", "icon": "/docs.svg" }, - { "label": "API", "href": "/api", "icon": "/api.svg" } - ] - } - } -} -Internationalization -Language Configuration -Code example: -{ - "localization": { - "defaultLocale": "en", - "fallbackLocale": "en", - "locales": [ - { - "code": "en", - "name": "English", - "flag": "πŸ‡ΊπŸ‡Έ" - }, - { - "code": "es", - "name": "EspaΓ±ol", - "flag": "πŸ‡ͺπŸ‡Έ" - }, - { - "code": "fr", - "name": "FranΓ§ais", - "flag": "πŸ‡«πŸ‡·" - }, - { - "code": "de", - "name": "Deutsch", - "flag": "πŸ‡©πŸ‡ͺ" - } - ] - }, - "translation": { - "auto_translate": true, - "provider": "anthropic", - "model": "claude-3-sonnet-20240229", - "targetLanguages": ["es", "fr", "de"], - "excludedPaths": ["_meta.json"] - }, -} -------------- [Document: docs/guides/analytics.json] Title: Analytics Integration Learn how to add analytics tracking to your documentation @@ -523,428 +115,17 @@ Code example: } This provides a complete analytics integration that's easy for users to set up and extend as needed. ------------- -[Document: docs/editor/overview.json] -Title: Editor Overview -AkiraDocs features a modern, Notion-like editor that combines the simplicity of block-based editing with the power of Markdown. -Editor Interface -Main Components -Toolbar: Quick access to formatting options and block types -Content Area: Block-based editing space -Sidebar: Navigation and document structure -Command Palette: Quick commands (Ctrl/Cmd + P) -Block Structure -Each content element is a block that can be: -Dragged and dropped to reorganize -Converted between different types -Duplicated or deleted -Nested within other blocks -Getting Started -Creating Content -1. Click the '+' button or press '/' to add a new block -2. Choose block type from the popup menu -3. Start typing or add content -Basic Operations -Code example: -/ β†’ Open block menu -⌘/Ctrl + P β†’ Command palette -⌘/Ctrl + / β†’ Show keyboard shortcuts -↑↓ β†’ Navigate between blocks -Block Types -Text Blocks -Paragraphs -Headings (H1-H6) -Lists (Bulleted, Numbered) -Quotes -Callouts -Rich Media -Images -Videos -Embeds -Files -Code blocks -Special Blocks -Tables (Coming Soon) -Dividers -Custom components (Coming Soon) -------------- -[Document: docs/editor/features.json] -Title: Editor Features -Detailed overview of AkiraDocs editor capabilities and features. -Block System -Text Formatting -Basic Formatting -Bold, italic, underline -Strikethrough -Highlight -Code inline -Advanced Formatting -Custom colors -Multiple fonts -Text alignment -Indentation -Content Blocks -Rich Text -Code example: -# Heading 1 -## Heading 2 -> Blockquote -- Bullet list -1. Numbered list -Code Blocks -Code example: -// Syntax highlighting -console.log('Hello World'); -Media Blocks -Image upload and embedding -Video embedding -File attachments -Interactive embeds -AI Features -Content Enhancement -Grammar and style suggestions -Content optimization -SEO recommendations -Translation assistance -Smart Formatting -Auto-formatting -Smart lists -Table formatting -Code block language detection -Collaboration Features -Version Control -Git integration -Change history -Rollback capabilities -------------- -[Document: docs/contributing/how-to-contribute.json] -Title: Contributing to AkiraDocs -Guide to contributing to the AkiraDocs open-source project. -Getting Started -Setup Development Environment -Code example: -# Clone repository -git clone https://github.com/Cloud-Code-AI/akiradocs -cd akiradocs - -# Install dependencies -npm install - -# Start development server -npm run dev -Contribution Guidelines -Types of Contributions -Bug fixes -Feature additions -Documentation improvements -Translation help -Issue reporting -Pull Request Process -1. Fork the repository -2. Create feature branch -3. Make changes -4. Submit pull request -Commit Messages -Code example: -# Format -type(scope): description - -# Examples -feat(editor): add new block type -fix(translation): correct language detection -docs(api): update authentication guide -Development Guidelines -Code Style -Follow existing patterns -Use TypeScript -Add comments -Write tests -Testing -Code example: -# Run tests -npm run test - -# Check types -npm run type-check - -# Lint code -npm run lint -Documentation -Update Docs -1. Edit relevant files -2. Update examples -3. Check links -4. Verify formatting -Create Examples -Clear and concise -Well-documented -Tested -Maintainable -Getting Help -Join [Discord](https://discord.gg/zvYZukgeH2) -Check [Issues](https://github.com/Cloud-Code-AI/akiradocs/issues) -Read [Documentation](https://docs.akiradocs.com) -------------- -[Document: docs/contributing/code-of-conduct.json] -Title: Code of Conduct -Our Pledge -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. -Our Standards -Examples of behavior that contributes to a positive environment: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes -* Focusing on what is best for the overall community -Examples of unacceptable behavior: -* The use of sexualized language or imagery, and sexual attention or advances -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting -Enforcement Responsibilities -Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. -Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly. -Attribution -This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. -------------- -[Document: docs/getting-started/requirements.json] -Title: System Requirements -Before installing AkiraDocs, ensure your environment meets the following requirements. -Minimum Requirements -Node.js -Version: 16.x or higher -Recommended: Latest LTS version -System Memory -Minimum: 2GB RAM -Recommended: 4GB RAM or more -Storage -Recommended: 1GB free space -Software Dependencies -Required -Git (latest version recommended) -npm or yarn package manager -Modern web browser (Chrome, Firefox, Safari, Edge) -Optional -Docker (for containerized deployment) -PostgreSQL (for enterprise features) -Development Environment -Supported Operating Systems -macOS (10.15 or later) -Windows 10/11 -Linux (Ubuntu 20.04 or later recommended) -IDE/Editor Support -VS Code (coming soon) -WebStorm (coming soon) -Any text editor with Markdown support -------------- [Document: docs/getting-started/quickstart.json] Title: Quickstart Guide -Get up and running with AkiraDocs in minutes. -Quick Deploy -Option 1: Deploy with Vercel -The fastest way to get started is using Vercel: -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FCloud-Code-AI%2Fakiradocs-template) -Option 2: Using CLI -Create a new project using our CLI: -Code example: -npx create-akiradocs@latest my-docs -Basic Setup Steps -1. Clone the Repository (if not using Quick Deploy) +Get up and running with Akira Docs in minutes +Follow these steps to start using Akira Docs for your documentation needs. Code example: +bash git clone https://github.com/your-org/akira-docs-template cd akira-docs-template -2. Install Dependencies -Code example: npm install -# or -yarn install -3. Start Development Server -Code example: npm run dev -# or -yarn dev -4. Open `http://localhost:3000` in your browser -Initial Configuration -1. Update Site Configuration -Edit `akiradocs.config.json`: -Code example: -{ - "site": { - "title": "Your Docs", - "description": "Your documentation description" - } -} -2. Configure Translation (Optional) -Code example: -{ - "translation": { - "auto_translate": true, - "provider": "anthropic", - "targetLanguages": ["es", "fr", "de"] - } -} -------------- -[Document: docs/getting-started/features.json] -Title: AkiraDocs Features -A comprehensive overview of AkiraDocs' core features and capabilities. -Content Creation & Management -Notion-like Editor: Intuitive block-based interface with real-time preview -Markdown Support: Native Markdown and MDX compatibility -Custom Components: Create and reuse your own content blocks -Internationalization & Translation -Multi-Language Support: Maintain documentation in multiple languages -AI-Powered Translation: Automated, context-aware content translation -Translation Management: Built-in tools for managing localized content -Search & Discovery -AI-Powered Search: Natural language question answering with context awareness -SEO Optimization: Automated SEO tools and optimizations -Smart Indexing: Real-time search index updates -Build & Performance -Static Generation: Optimized build process with asset optimization -Developer Experience: Fast refresh and comprehensive debugging tools -Performance Focus: Built-in best practices for speed and efficiency -Enterprise Features (Coming Soon) -Security & Compliance: SSO, RBAC, and audit logging -Analytics & Insights: Usage tracking and documentation metrics -Team Collaboration: Enterprise-grade collaboration tools -Migration Support (Coming Soon) -Code example: -# Supported platforms for easy migration -βœ“ Nextra -βœ“ GitBook -βœ“ Docusaurus -βœ“ ReadTheDocs -------------- -[Document: docs/content-management/creating-pages.json] -Title: Creating and Organizing Pages -Learn how to create, structure, and organize your documentation pages in AkiraDocs. You can create markdown pages or just use the editor UI. Note in _contents folder, you will only see markdown content created by you. If you use Editor UI, the content will be saved in the compiled folder and will be automatically translated to other languages. -Page Structure -Basic Page Template -Code example: ---- -title: Your Page Title -description: Brief description of the page -author: Your Name -publishDate: 2024-11-26 -modifiedDate: 2024-11-26 -category: Category Name -keywords: - - keyword1 - - keyword2 ---- - -# Main Title - -Content starts here... -Directory Structure -Code example: -folder_name/ -β”œβ”€β”€ _contents/ -β”‚ β”œβ”€β”€ en/ -β”‚ β”‚ β”œβ”€β”€ getting-started/ -β”‚ β”‚ β”œβ”€β”€ guides/ -β”‚ β”‚ └── api/ -You can just create pages for default language (en) and AkiraDocs will automatically translate them to other languages. -Creating New Pages -Method 1: Using the UI -1. Click "New Page" in the sidebar -2. Start adding content -Method 2: Direct File Creation -1. Create a new `.md` file in the appropriate directory -2. Add required frontmatter -3. Write content using Markdown -4. Save and compile -Page Organization -Categories and Tags -Use consistent categories -Apply relevant tags -Organize by topic -Create logical hierarchies -Navigation Structure -This is automatically generated from the folder structure. You can customize it by editing the `_meta.json` file inside compiled folder. -Code example: -{ - "docs": { - "getting-started": { - "title": "Getting Started", - "items": { - "introduction": { - "title": "Introduction", - "path": "/docs/getting-started/introduction" - } - } - } - } -} -------------- -[Document: docs/api-reference/usage-guide.json] -Title: API Documentation Guide -Learn how to generate comprehensive API documentation using AkiraDocs. -Quick Start -Upload API Spec -1. Place your OpenAPI/Swagger spec in: -Code example: -_contents/{language_code}/api/apiSpec.json -2. AkiraDocs automatically generates documentation. -Example API Spec -Code example: -{ - "openapi": "3.0.0", - "info": { - "title": "Sample API", - "version": "1.0.0" - }, - "paths": { - "/users": { - "get": { - "summary": "Get users", - "responses": { - "200": { - "description": "Success" - } - } - } - } - } -} -Generated Documentation -Automatic Features -Interactive API explorer -Code samples in multiple languages -Request/response examples -Authentication documentation -Example Output -Code example: -// Example: Get Users -const response = await fetch('https://api.example.com/users', { - method: 'GET', - headers: { - 'Authorization': 'Bearer YOUR_TOKEN' - } -}); - -const users = await response.json(); -Customization -Theme Options -Code example: -{ - "api": { - "docs": { - "theme": "dark", - "syntaxHighlight": true, - "showExamples": true - } - } -} -Language Selection -Code example: -{ - "api": { - "examples": { - "languages": ["javascript", "python", "curl"] - } - } -} +:::warning Prerequisites +Make sure you have Node.js 16 or higher installed on your system. +::: ------------- \ No newline at end of file diff --git a/docs/scripts/generate-sitemap.mjs b/docs/scripts/generate-sitemap.mjs index a45ed63..926f747 100644 --- a/docs/scripts/generate-sitemap.mjs +++ b/docs/scripts/generate-sitemap.mjs @@ -1,16 +1,9 @@ // Basic sitemap generator example -import { writeFileSync, readFileSync } from 'fs'; +import { writeFileSync } from 'fs'; import { globSync } from 'glob'; import path from 'path'; -// Read config file -const config = JSON.parse(readFileSync('./akiradocs.config.json', 'utf8')); -let BASE_URL = config.url || ''; - -// Ensure BASE_URL has proper https:// or http:// prefix -if (!BASE_URL.startsWith('http://') && !BASE_URL.startsWith('https://')) { - BASE_URL = `https://${BASE_URL}`; -} +const BASE_URL = 'https://your-domain.com'; // Replace with your actual domain const pages = globSync('compiled/**/*.json') .map(file => { diff --git a/docs/src/app/[locale]/[type]/[...slug]/page.tsx b/docs/src/app/[locale]/[type]/[...slug]/page.tsx index 0a594c4..5bb10a4 100644 --- a/docs/src/app/[locale]/[type]/[...slug]/page.tsx +++ b/docs/src/app/[locale]/[type]/[...slug]/page.tsx @@ -1,5 +1,3 @@ -'use client' - import React from 'react' import { getContentBySlug, getContentNavigation } from '@/lib/content' import { BlockRenderer } from '@/lib/renderers/BlockRenderer' @@ -9,18 +7,20 @@ import Navigation from '@/components/layout/Navigation' import TableOfContents from '@/components/layout/TableOfContents' import { getHeaderConfig } from '@/lib/headerConfig' import { getFooterConfig } from '@/lib/footerConfig' -import { Button } from '@/components/ui/button' -import { Edit2 } from 'lucide-react' import { PageBreadcrumb } from '@/components/layout/Breadcrumb' import { getNextPrevPages } from '@/lib/navigationUtils' import { PageNavigation } from '@/components/layout/PageNavigation' import { MainTitle, SubTitle } from '@/components/blocks/HeadingBlock' import { SEO } from '@/components/layout/SEO' import { NotFound } from '@/components/layout/NotFound' -import { TextToSpeech } from '@/components/tts/TextToSpeech' +// import { TextToSpeech } from '@/components/tts/TextToSpeech' import { getAkiradocsConfig } from "@/lib/getAkiradocsConfig"; +import { getTranslation } from '@/lib/staticTranslation'; +import { ClientSideControls } from '@/components/layout/ClientSideControl'; +import { Metadata } from 'next' -export const runtime = 'edge' +// export const runtime = 'edge' +export const dynamic = 'force-static'; const PostContainer = ({ children }: { children: React.ReactNode }) => (
@@ -28,29 +28,86 @@ const PostContainer = ({ children }: { children: React.ReactNode }) => (
) -export default function ContentPage({ params }: { params: Promise<{ locale: string, type: string, slug: string[] }> }) { - const resolvedParams = React.use(params) - const locale = resolvedParams.locale - const type = resolvedParams.type - const slug = resolvedParams.slug?.length ? resolvedParams.slug.join('/') : '' - const post = getContentBySlug(locale, type, slug) +type Props = { + params: Promise<{ + locale: string; + type: string; + slug: string[]; + }>; +} + +export async function generateStaticParams() { + const locales = ['en', 'es', 'fr']; + const types = ['docs', 'api', 'articles']; + const allSlugs: { locale: string, type: string, slug: string[] }[] = []; + + locales.forEach(locale => { + types.forEach(type => { + const navigationItems = getContentNavigation({}, locale, type); + if (Array.isArray(navigationItems)) { + navigationItems.forEach(item => { + if (item.slug) { + allSlugs.push({ locale, type, slug: item.slug.split('/') }); + } + }); + } + }); + }); + + return allSlugs; +} + +export async function generateMetadata({ params }: Props): Promise { + const resolvedParams = await Promise.resolve(params); + const { locale, type, slug: slugArray } = resolvedParams; + + const slug = slugArray.length ? slugArray.join('/') : ''; + const post = getContentBySlug(locale, type, slug); + const t = getTranslation(locale as 'en' | 'es' | 'fr'); + const akiradocsConfig = getAkiradocsConfig(); + + return { + title: t(post?.title) || 'Documentation', + description: t(post?.description) || 'Documentation content', + alternates: { + canonical: `${akiradocsConfig.site.url}/${locale}/${type}/${slug}`, + languages: { + 'en': `${akiradocsConfig.site.url}/en/${type}/${slug}`, + 'es': `${akiradocsConfig.site.url}/es/${type}/${slug}`, + 'fr': `${akiradocsConfig.site.url}/fr/${type}/${slug}`, + } + }, + openGraph: { + title: t(post?.title) || 'Documentation', + description: t(post?.description) || 'Documentation content', + url: `${process.env.NEXT_PUBLIC_SITE_URL}/${locale}/${type}/${slug}`, + siteName: 'Your Site Name', + locale: locale, + type: 'article', + } + } +} + +export default async function ContentPage({ params }: Props) { + const resolvedParams = await Promise.resolve(params); + const { locale, type, slug: slugArray } = resolvedParams; + const t = getTranslation(locale as 'en' | 'es' | 'de'); + + const slug = slugArray.length ? slugArray.join('/') : ''; + const post = getContentBySlug(locale, type, slug); + if (!post) { - return + return ; } - const akiradocsConfig = getAkiradocsConfig() - const config = getAkiradocsConfig() + + const akiradocsConfig = getAkiradocsConfig(); const headerConfig = getHeaderConfig(); const footerConfig = getFooterConfig(); - const navigationItems = getContentNavigation({}, locale, type) + const navigationItems = getContentNavigation({}, locale, type); const { prev, next } = getNextPrevPages(navigationItems, `/${type}/${slug}`); - const pageTitle = post.title || 'Documentation' - const pageDescription = post.description || 'Documentation content' - const canonicalUrl = `${process.env.NEXT_PUBLIC_SITE_URL}/${locale}/${type}/${slug}` - const handleEdit = () => { - const fileSlug = slug !== '' ? slug : post.id || post.filename?.replace('.json', '') - const filePath = `${locale}/${type}/${fileSlug}.json` - window.location.href = `/editor/${filePath}` - } + const pageTitle = t(post.title) || t('common.documentation'); + const pageDescription = t(post.description) || t('common.documentationContent'); + const canonicalUrl = `${process.env.NEXT_PUBLIC_SITE_URL}/${locale}/${type}/${slug}`; return (
@@ -67,35 +124,40 @@ export default function ContentPage({ params }: { params: Promise<{ locale: stri
- {process.env.NEXT_PUBLIC_AKIRADOCS_EDIT_MODE === 'true' && ( - - )} - {akiradocsConfig.features.textToSpeech && ( - - )} +
- {post.title} - {post.description} + {t(post.title)} + {t(post.description)} {post.blocks.map((block) => ( block.content !== post.title && ( - + ) ))} - +
- +