Configuration

INFO

Check the docuo.config.json API reference for an exhaustive list of options.

Docuo has a unique take on configurations. We encourage you to congregate information about your site into one place. We guard the fields of this file and facilitate making this data object accessible across your site.

Keeping a well-maintained docuo.config.json helps you, your collaborators, and your open source contributors to be able to focus on documentation while still being able to customize the site.

Syntax to declare docuo.config.json

The docuo.config.json file is run in Node.js and should returns a standard json format of content.

{
  "title": "Your site title",
  "favicon": "Your site favicon",
  "themeConfig": {
    "navbar": {
      "title": "Your navbar title",
      "logo": "Your navbar logo",
      "items": [
        {
          "type": "docSidebar",
          "sidebarIds": ["mySidebar"],
          "label": "Documentation",
          "position": "left"
        }
      ]
    },
    "footer": {
      "logo": "Your footer logo",
      "caption": "Your caption",
      "links": [
        {
          "title": "Product",
          "items": [
            {
              "label": "documentation",
              "to": "/"
            }
          ]
        }
      ],
      "socials": [
        {
          "logo": "Twitter",
          "href": "Your twitter url"
        },
        {
          "logo": "LinkedIn",
          "href": "Your linkedin url"
        },
        {
          "logo": "Discord",
          "href": "Your discord url"
        },
        {
          "logo": "Github",
          "href": "Your github url"
        }
      ]
    }
  }
}

What goes into a docuo.config.json?

The high-level overview of Docuo configuration can be categorized into:

• Site metadata
• Theme configurations

Site metadata

Site metadata contains the essential global metadata such as title and favicon.

They are used in several places such as your site's title and headings, browser tab icon, social sharing (Facebook, Twitter) information.

It is recommended to check the sitemeta docs for more information.

Theme configurations

Theme config 包括生成站点主题所需要的所有配置，主要包括布局和样式两大类，其中样式配置暂不支持，敬请期待 对于布局控制：navbar、footer 配置项可控制顶部导航栏及页脚元素布局，还可以定义anchors和tabs来控制文档内容的分组显示

It is recommended to check the themeConfig docs for more information.