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

1---
2title: Your Page Title
3description: Brief description of the page
4author: Your Name
5publishDate: 2024-11-26
6modifiedDate: 2024-11-26
7category: Category Name
8keywords:
9  - keyword1
10  - keyword2
11---
12
13# Main Title
14
15Content starts here...

Directory Structure

1folder_name/
2β”œβ”€β”€ _contents/
3β”‚   β”œβ”€β”€ en/
4β”‚   β”‚   β”œβ”€β”€ getting-started/
5β”‚   β”‚   β”œβ”€β”€ guides/
6β”‚   β”‚   └── 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.

1{
2  "docs": {
3    "getting-started": {
4      "title": "Getting Started",
5      "items": {
6        "introduction": {
7          "title": "Introduction",
8          "path": "/docs/getting-started/introduction"
9        }
10      }
11    }
12  }
13}