docs/docusaurus.config.ts at main · VirtualClient/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
import remarkA11yEmoji from "@fec/remark-a11y-emoji";
import vsDark from "prism-react-renderer/themes/vsDark";
import navbar from "./config/navbar.config";
import footer from "./config/footer.config";
import { env } from "process";
import { Config } from "@docusaurus/types";
import { Options } from "@docusaurus/plugin-content-docs";

const preview = env.VERCEL_ENV === "preview";

const url = (preview && env.VERCEL_URL) || "https://docs.virtualclient.gg";

const docsCommon: Options = {
  breadcrumbs: true,
  editUrl: ({ docPath }) => `https://github.com/VirtualClient/docs/blob/main/docs/server-api/${docPath}`,
  editCurrentVersion: true,
  remarkPlugins: [remarkA11yEmoji],
  showLastUpdateAuthor: true,
  showLastUpdateTime: true,
};

const config: Config = {
  title: "VirtualClient Documentation",
  tagline: "",
  url: url,
  baseUrl: "/",
  onBrokenLinks: "warn",
  onBrokenMarkdownLinks: "warn",
  onDuplicateRoutes: "warn",
  favicon: "img/favicon.ico",
  trailingSlash: false,
  noIndex: preview,
  baseUrlIssueBanner: false,
  clientModules: [require.resolve("../src/css/custom.css")],

  webpack: {
    jsLoader: (isServer) => ({
      loader: require.resolve("esbuild-loader"),
      options: {
        loader: "tsx",
        target: isServer ? "node12" : "es2017",
      },

    }),
  },

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

  plugins: [
    'docusaurus-plugin-image-zoom',

    [
      "content-docs",
      {
        ...docsCommon,
        id: "serverApi",
        path: "docs/server-api",
        routeBasePath: "server-api",
        sidebarPath: require.resolve("./config/sidebar.serverApi"),
        lastVersion: "current",
        versions: {
          current: {
            label: "0.0.13",
            path: "",
          },
        },
      },
    ],

    [
      "content-pages",
      {
        remarkPlugins: [remarkA11yEmoji],
      },
    ],

    [
      "@docusaurus/plugin-sitemap",
      {
        ignorePatterns: ["**/cat/**"],
      },
    ],
    "@docusaurus/plugin-debug",
  ],

  themeConfig: {
    colorMode: {
      respectPrefersColorScheme: true,
    },
    zoom: {
      selector: '.markdown :not(em) > img',
      background: {
        light: 'rgb(255, 255, 255)',
        dark: 'rgb(50, 50, 50)'
      },
      // options you can specify via https://github.com/francoischalifour/medium-zoom#usage
      config: {
      }
    },
    image: "img/og-image.png",
    metadata: [
      {
        name: "og:type",
        content: "website",
      },
      {
        name: "og:image:alt",
        content: "VirtualClient Logo",
      },
    ],
    navbar: navbar,
    footer: footer,
    prism: {
      additionalLanguages: [
        "batch",
        "bash",
        "git",
        "java",
        "javastacktrace",
        "kotlin",
        "groovy",
        "log",
        "toml",
        "properties",
      ],
      theme: vsDark,
    },
  },
};

export = config;