protobuf.com/docusaurus.config.js at main · bufbuild/protobuf.com · 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
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require("prism-react-renderer").themes.github;
const darkCodeTheme = require("prism-react-renderer").themes.dracula;
const gaTrackingID = process.env.GOOGLE_ANALYTICS_GTAG ?? "";

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "The Protobuf Language",
  tagline: "A platform-agnostic way to describe data structures and interfaces.",
  url: "https://protobuf.com",
  baseUrl: "/",
  onBrokenLinks: "throw",
  favicon: "img/favicon.png",
  markdown: {
    hooks: {
      onBrokenMarkdownLinks: "throw",
    },
  },

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "bufbuild", // Usually your GitHub org/user name.
  projectName: "protobuf.com", // Usually your repo name.

  scripts: [
    {
      src: "https://sparkling-delightful.protobuf.com/script.js",
      "data-site": "NXKPYXNZ",
      "data-spa": "auto",
      defer: true,
    },
  ],

  // Even if you don't use internalization, you can use this field to set useful
  // metadata like html lang. For example, if your site is Chinese, you may want
  // to replace "en" with "zh-Hans".
  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },

  presets: [
    [
      "classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          // "oldschool" converts -- to an em-dash (—), following the
          // typewriter convention used throughout the docs content.
          remarkPlugins: [[require("remark-smartypants").default, { dashes: "oldschool" }]],
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],

  plugins: [
    gaTrackingID !== ""
      ? [
          "@docusaurus/plugin-google-gtag",
          {
            trackingID: gaTrackingID,
            anonymizeIP: true,
          },
        ]
      : null,
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      // algolia: {
      //   appId: process.env.ALGOLIA_APP_ID || "none",
      //   apiKey: process.env.ALGOLIA_API_KEY || "none",
      //   indexName: process.env.ALGOLIA_INDEX_NAME || "none"
      // },
      // fathomAnalytics: {
      //   siteId: process.env.FATHOM_ANALYTICS_SITE_ID || "none",
      //   customDomain: process.env.FATHOM_ANALYTICS_CUSTOM_DOMAIN || "none"
      // },
      navbar: {
        title: "Protobuf Guide",
      },
      footer: {
        style: "dark",
        links: [],
        copyright: `Copyright © ${
          new Date().getFullYear() !== 2022 ? "2022&ndash;" : ""
        }${new Date().getFullYear()} Buf Technologies, Inc.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
        additionalLanguages: ["protobuf", "ebnf"],
      },
      tableOfContents: {
        minHeadingLevel: 2,
        maxHeadingLevel: 5,
      },
      colorMode: {
        disableSwitch: false,
        respectPrefersColorScheme: true,
      },
    }),
};

module.exports = config;