Global Settings

global configuration for your DocuBook project

Setup docu.json

Follow the instructions for writing the JSON schema in the DocuBook project to understand the standard structure of the docu.json file :

docu.json
{
  "$schema": "https://docubook.pro/docu.schema.json",
  "meta": {
    "baseURL": "https://docubook.pro",
    "title": "DocuBook",
    "description": "DocuBook is a modern documentation platform for building, deploying, and managing your docs with ease.",
    "favicon": "/favicon.ico"
  },
  "navbar": {
      "logo": {
        "src": "/images/docu.svg",
        "alt": "DocuBook Logo"
      },
      "logoText": "DocuBook",
      "menu": [
        { "title": "Home", "href": "/" },
        { "title": "Docs", "href": "/docs/getting-started/introduction" },
        { "title": "Community", "href": "https://docubook.pro" }
      ]
  },
  "repository": {
    "url": "https://github.com/DocuBook/docubook",
    "editPathTemplate": "/blob/main/{filePath}",
    "editLink": true
  },
  "sponsor": {
    "title": "Hosted on",
    "item": {
      "title": "Vercel",
      "description": "Deploy your DocuBook app with zero configuration.",
      "image": "/images/vercel.png",
      "url": "https://vercel.com/import/project?template=https://github.com/DocuBook/docubook"
    }
  },
  "footer": {
    "copyright": "DocuBook",
    "social": [
      {
          "name": "Instagram",
          "url": "https://www.instagram.com/wildan.nrs",
          "iconName": "InstagramIcon"
      },
      {
          "name": "Facebook",
          "url": "https://www.facebook.com/wildan.nrsh",
          "iconName": "FacebookIcon"
      },
      {
          "name": "Twitter",
          "url": "https://x.com/wildan_nrss",
          "iconName": "TwitterIcon"
      },
      {
          "name": "Youtube",
          "url": "https://www.youtube.com/@wildan.nrs_",
          "iconName": "YoutubeIcon"
      }
      ]
    },
    "routes": [
      {
      "title": "Getting Started",
      "href": "/getting-started",
      "noLink": true,
      "context": {
              "icon": "Book",
              "description": "Set up your Documentation",
              "title": "Guides"
              },
              "items": [
                      { "title": "Introduction", "href": "/introduction" },
                      { "title": "Quick Start Guide", "href": "/quick-start-guide" },
                      { "title": "Development", "href": "/development" }
              ]
      },
      {
      "title": "Api Reference",
      "href": "/api-reference",
      "noLink": true,
      "context": {
              "icon": "Terminal",
              "description": "reference for using the API",
              "title": "API Reference"
              },
              "items": [
                      { "title": "Get", "href": "/get" },
                      { "title": "Fetch", "href": "/fetch" },
                      { "title": "Post", "href": "/post" },
                      { "title": "Delete", "href": "/delete" }
              ]
      },
      {
      "title": "Changelog",
      "href": "/Changelog",
      "noLink": true,
      "context": {
              "icon": "History",
              "description": "Update and Changes",
              "title": "Release"
              },
              "items": [
                      { "title": "version 1", "href": "/version-1" },
                      { "title": "version 2", "href": "/version-2" },
                      { "title": "version 3", "href": "/version-3" }
              ]
      }
    ]
}

Folder Structure

To match the routes with the folder structure, the hierarchy in docu.json should reflect the following:

The top-level routes correspond to the main folders under docs:
- getting-started
- api-reference
- changelog
Each route's items should represent the files or subfolders within those directories.

For example:

The "Getting Started" route should include items like "Introduction", "Quick Start Guide", and any sub-sections or configuration pages found in the getting-started folder.
The "Api Reference" route should include items for each API endpoint or reference page in the api-reference folder.
The "Changelog" route should include items for each version or release note in the changelog folder.

This structure ensures that the navigation in your documentation matches the actual folder and file organization in your project.

contents/
└── docs/
    ├── getting-started/
    │   ├── introduction/
    │   │   └── index.mdx
    │   ├── quick-start-guide/
    │   │   └── index.mdx
    │   └── development/
    │       └── index.mdx
    │
    ├── api-reference/
    │   ├── get/
    │   │   └── index.mdx
    │   ├── fetch/
    │   │   └── index.mdx
    │   ├── post/
    │   │   └── index.mdx
    │   └── delete/
    │       └── index.mdx
    │
    └── changelog/
        ├── version-1/
        │   └── index.mdx
        ├── version-2/
        │   └── index.mdx
        └── version-3/
            └── index.mdx