Getting started

Configuration

Config file

The shiso.config.json file contains the configuration options for your project.

The file has the following schema:

{
  "docs": {
    "tabs": [],
    "navigation": {}
  },
  "blog": {}
}

At the root level, the properties represent the different content sections of your project. Shiso currently supports docs and blog content.

Docs options

{
  "docs": {
    "tabs": [
      {
        "id": "docs",
        "label": "Documentation",
        "url": "/docs"
      },
      {
        "id": "components",
        "label": "Components",
        "url": "/docs/components"
      }
    ],
    "navigation": {
      "docs": [
        {
          "group": "Getting started",
          "pages": [
            {
              "label": "Overview",
              "url": "/docs"
            },
            {
              "label": "Installation",
              "url": "/docs/installation"
            }
          ]
        },
        {
          "group": "Basics",
          "pages": [
            {
              "label": "Writing content",
              "url": "/docs/writing-content"
            }
          ]
        }
      ],
      "components": [
        {
          "group": "Components",
          "pages": [
            {
              "label": "Overview",
              "url": "/docs/components"
            }
          ]
        }
      ]
    }
  }
}

Blog options

...