Global Settings

Every WriteDocs documentation site requires a config.json file to handle the essential configuration settings. Explore the available attributes below to get started.

Key details

Click on each key on the JSON examples below (indicated by the Click here! tag below) to see details about each.

Basic version

1{
2  "websiteName": "MyCompany Docs",
3  "description": "Project Description",
4  "images": {
5    "logo": "media/logo.png",
6    "favicon": "media/favicon.ico"
7  },
8  "styles": {
9    "mainColor": "#3778fd"
10  },
11  "homepage": "/introduction",
12  "navbar": [
13    {
14      "label": "Guides",
15      "sidebarRef": "docs"
16    },
17    {
18      "label": "API Reference",
19      "dropdown": [
20        {
21          "label": "v1.0",
22          "sidebarRef": "apiReference"
23        }
24      ]
25    }
26  ],
27  "sidebars": [
28    {
29      "sidebarRef": "guides",
30      "categories": [
31        {
32          "categoryName": "Getting Started",
33          "pages": [
34            "getting-started/overview",
35            {
36              "page": "getting-started/quickstart/quickstart",
37              "groupName": "Quickstart",
38              "subpages": [
39                "getting-started/quickstart/beginners-guide"
40              ]
41            },
42            "getting-started/global-settings"
43          ]
44        }
45      ]
46    }
47  ]
48}
Click here!

Full Version

1{
2  "websiteName": "MyCompany Docs",
3  "description": "Project Description",
4  "images": {
5    "logo": "media/logo.png",
6    "favicon": "media/favicon.ico",
7    "darkLogo": ""
8  },
9  "styles": {
10    "mainColor": "#3778fd",
11    "darkModeMainColor": "",
12    "navbarColor": "#000",
13    "navbarDarkModeColor": "#3778fd",
14    "backgroundDarkModeColor": "",
15    "logoSize": "",
16    "navbarMode": "",
17    "pagination": false
18  },
19  "colorMode": {
20    "default": "dark",
21    "switchOff": true
22  },
23  "apiFiles": [
24    "example.yml"
25  ],
26  "homepage": "/introduction",
27  "changelog": true,
28  "externalLinks": [
29    {
30      "link": "https://github.com/orgs/writedocs/repositories",
31      "name": "Github"
32    }
33  ],
34  "integrations": {
35    "gtag": "replace_with_your_gtag",
36    "posthog": {
37      "api_key": "replace_with_your_posthog_api_key",
38      "api_host": "replace_with_your_posthog_api_host"
39    }
40  },
41  "navbar": [
42    {
43      "label": "Guides",
44      "sidebarRef": "docs"
45    },
46    {
47      "label": "API Reference",
48      "dropdown": [
49        {
50          "label": "v1.0",
51          "sidebarRef": "apiReference"
52        }
53      ]
54    }
55  ],
56  "sidebars": [
57    {
58      "sidebarRef": "guides",
59      "categories": [
60        {
61          "categoryName": "Getting Started",
62          "pages": [
63            "getting-started/overview",
64            {
65              "page": "getting-started/quickstart/quickstart",
66              "groupName": "Quickstart",
67              "subpages": [
68                "getting-started/quickstart/beginners-guide"
69              ]
70            },
71            "getting-started/global-settings"
72          ]
73        }
74      ]
75    }
76  ]
77}
Click here!