vef-framework-react-docs/docusaurus.config.ts at main · coldsmirk/vef-framework-react-docs · 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
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import { themes as prismThemes } from "prism-react-renderer";

const config: Config = {
  title: "VEF Framework React",
  tagline: "Enterprise React framework docs focused on the public API surface",
  favicon: "img/favicon.svg",

  future: {
    v4: true,
  },

  url: "https://coldsmirk.github.io",
  baseUrl: "/vef-framework-react-docs/",

  organizationName: "coldsmirk",
  projectName: "vef-framework-react-docs",

  onBrokenLinks: "throw",

  markdown: {
    mermaid: true,
    hooks: {
      onBrokenMarkdownLinks: "warn",
    },
  },

  themes: ["@docusaurus/theme-mermaid"],

  i18n: {
    defaultLocale: "en",
    locales: ["en", "zh-Hans"],
    localeConfigs: {
      en: {
        label: "English",
        direction: "ltr",
      },
      "zh-Hans": {
        label: "简体中文",
        direction: "ltr",
      },
    },
  },

  presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
        },
        blog: false,
        theme: {
          customCss: "./src/css/custom.css",
        },
      } satisfies Preset.Options,
    ],
  ],

  plugins: [
    // WORKAROUND: mermaid's transitive dependency vscode-languageserver-types
    // ships a UMD build using dynamic require(), which Rspack (faster) flags as
    // a "Critical dependency" warning. It is a false positive that does not
    // affect the generated site. Remove this plugin once the upstream chain
    // (mermaid -> langium -> vscode-languageserver-types) no longer emits it.
    function suppressMermaidUmdWarning() {
      return {
        name: "suppress-mermaid-umd-warning",
        configureWebpack() {
          return {
            ignoreWarnings: [{ module: /vscode-languageserver-types/ }],
          };
        },
      };
    },
  ],

  themeConfig: {
    image: "img/logo.svg",
    colorMode: {
      respectPrefersColorScheme: true,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.vsDark,
      additionalLanguages: ["bash", "json", "tsx"],
    },
    navbar: {
      title: "VEF Framework React",
      logo: {
        alt: "VEF Framework Logo",
        src: "img/logo.svg",
      },
      items: [
        {
          type: "docSidebar",
          sidebarId: "docsSidebar",
          position: "left",
          label: "Docs",
        },
        {
          type: "localeDropdown",
          position: "right",
        },
        {
          href: "https://github.com/coldsmirk/vef-framework-react",
          label: "GitHub",
          position: "right",
        },
      ],
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "Docs",
          items: [
            {
              label: "Introduction",
              to: "/docs/intro",
            },
            {
              label: "Quick Start",
              to: "/docs/getting-started/quick-start",
            },
            {
              label: "API Reference",
              to: "/docs/reference/overview",
            },
          ],
        },
        {
          title: "Community",
          items: [
            {
              label: "GitHub Issues",
              href: "https://github.com/coldsmirk/vef-framework-react/issues",
            },
            {
              label: "GitHub Discussions",
              href: "https://github.com/coldsmirk/vef-framework-react/discussions",
            },
          ],
        },
        {
          title: "More",
          items: [
            {
              label: "GitHub",
              href: "https://github.com/coldsmirk/vef-framework-react",
            },
            {
              label: "npm Package",
              href: "https://www.npmjs.com/package/vef-framework-react",
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} VEF Framework React.`,
    },
  } satisfies Preset.ThemeConfig,
};

export default config;