documentation/docusaurus.config.js at master · image-charts/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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
// @ts-check

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Image-Charts Documentation",
  tagline: "Generate chart images from a URL. Embed charts in emails, PDF reports, and more.",
  favicon: "img/favicon.ico",

  url: "https://documentation.image-charts.com",
  baseUrl: "/",

  organizationName: "image-charts",
  projectName: "documentation",

  onBrokenLinks: "throw",
  onBrokenAnchors: "throw",

  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  markdown: {
    mermaid: true,
  },

  clientModules: [require.resolve("./src/editor.js")],

  themes: [
    "@docusaurus/theme-mermaid",
    [
      require.resolve("@easyops-cn/docusaurus-search-local"),
      {
        hashed: true,
        language: ["en"],
        highlightSearchTermsOnTargetPage: true,
        explicitSearchResultPath: true,
        docsRouteBasePath: "/",
        indexBlog: false,
        searchBarShortcutHint: true,
        searchBarPosition: "right",
      },
    ],
  ],

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          routeBasePath: "/",
          sidebarPath: require.resolve("./sidebars.js"),
          editUrl: "https://github.com/image-charts/documentation/edit/master/docusaurus/",
        },
        blog: false,
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      image: "img/social-card.png",
      colorMode: {
        defaultMode: "light",
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
      navbar: {
        title: "Image-Charts",
        logo: {
          alt: "Image-Charts Logo",
          src: "img/logo.svg",
          href: "https://www.image-charts.com",
          target: "_self",
        },
        items: [
          {
            type: "docSidebar",
            sidebarId: "mainSidebar",
            position: "left",
            label: "Documentation",
          },
          {
            to: "/reference",
            label: "Reference",
            position: "left",
          },
          {
            to: "/guides",
            label: "Guides",
            position: "left",
          },
          {
            href: "https://editor.image-charts.com",
            label: "Chart Editor",
            position: "right",
            className: "navbar-editor-link",
          },
          {
            href: "https://github.com/image-charts",
            label: "GitHub",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Documentation",
            items: [
              { label: "Getting Started", to: "/" },
              { label: "Chart Types", to: "/bar-charts" },
              { label: "Reference", to: "/reference" },
              { label: "Guides", to: "/guides" },
            ],
          },
          {
            title: "Resources",
            items: [
              { label: "Gallery", to: "/gallery" },
              { label: "Enterprise", to: "/enterprise" },
              { label: "SDK & Libraries", to: "/sdk-and-libraries" },
              { label: "Errors", to: "/errors" },
            ],
          },
          {
            title: "More",
            items: [
              { label: "Status Page", href: "https://status.image-charts.com" },
              { label: "Changelog", href: "https://headwayapp.co/image-charts-changelog" },
              { label: "Chart Editor", href: "https://editor.image-charts.com" },
              { label: "GitHub", href: "https://github.com/image-charts" },
            ],
          },
          {
            title: "Contact",
            items: [
              { label: "Support", href: "mailto:support@image-charts.com" },
              { label: "Twitter", href: "https://twitter.com/imagecharts" },
              { label: "Stack Overflow", href: "https://stackoverflow.com/questions/tagged/image-charts" },
            ],
          },
        ],
        copyright: `Copyright ${new Date().getFullYear()} Image-Charts. All rights reserved.`,
      },
      prism: {
        theme: require("prism-react-renderer").themes.github,
        darkTheme: require("prism-react-renderer").themes.dracula,
        additionalLanguages: [
          "bash",
          "json",
          "yaml",
          "python",
          "javascript",
          "typescript",
          "php",
          "ruby",
          "java",
          "csharp",
          "sql",
        ],
      },
      mermaid: {
        theme: { light: "neutral", dark: "dark" },
      },
      tableOfContents: {
        minHeadingLevel: 2,
        maxHeadingLevel: 4,
      },
    }),
};

module.exports = config;