documentation/sidebars.ts at main · openremote/documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';

import restapiSidebar from "./docs/rest-api/sidebar";

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */
const sidebars: SidebarsConfig = {
  docsSidebar: [
    'introduction',
    'quick-start',
    {
      type: "category",
      label: "User Guide",
      collapsed: false,
      link: {
        type: "generated-index",
      },
      items: [
        {
          type: 'autogenerated',
          dirName: 'user-guide',
        },
      ]
    },
    {
      type: "category",
      label: "Tutorials",
      link: {
        type: "generated-index",
      },
      items: [
        {
          type: 'autogenerated',
          dirName: 'tutorials',
        },
      ]
    },
    {
      type: "category",
      label: "Developer Guide",
      link: {
        type: "generated-index",
      },
      items: [
        {
          type: 'autogenerated',
          dirName: 'developer-guide',
        },
      ]
    },
    {
      type: "category",
      label: "Architecture",
      link: {
        type: "generated-index",
      },
      items: [
        {
          type: 'autogenerated',
          dirName: 'architecture',
        },
      ]
    },
    {
      type: "category",
      label: "REST API",
      link: {
        type: "generated-index",
        title: "REST API",
        description:
          "This is the documentation for the OpenRemote Manager HTTP REST API.",
        slug: "/category/rest-api",
      },
      items: restapiSidebar.sort((a, b) => {
        if (a.label === "Schemas") {
          return 1;
        }
        else {
          return (a.label ?? '').localeCompare(b.label ?? '')
        }
      }),
    },
    {
      type: 'link',
      label: 'JavaDoc',
      href: 'https://www.javadoc.io/doc/io.openremote',
    },
 ],
};

export default sidebars;