git-filesystem.github.io/docusaurus.config.js at main · git-filesystem/git-filesystem.github.io · 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
/* eslint-disable @typescript-eslint/no-var-requires */
/* eslint-disable no-undef */

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Git-FileSystem",
  tagline: "Read & write to GitHub/GitLab/Bitbucket repositories like they're file systems.",
  url: "https://git-filesystem.github.io",
  baseUrl: "/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/favicon.ico",

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

  // 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"),
          // Please change this to your repo.
          // Remove this to remove the "edit this page" links.
          editUrl: "https://github.com/git-filesystem/git-filesystem/tree/main/",
          remarkPlugins: [[require("@docusaurus/remark-plugin-npm2yarn"), { sync: true }]]
        },
        blog: false,
        theme: {
          customCss: require.resolve("./src/css/custom.css")
        }
      })
    ]
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        title: "Git-FileSystem",
        logo: {
          alt: "Git-FileSystem Logo",
          src: "img/logo.svg"
        },
        items: [
          {
            type: "doc",
            docId: "/category/typescript",
            position: "left",
            label: "TypeScript"
          },
          {
            href: "https://github.com/git-filesystem",
            position: "right",
            className: "header-github-link",
            "aria-label": "GitHub repository"
          }
        ]
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "General",
            items: [
              {
                label: "GitHub",
                to: "https://github.com/git-filesystem"
              }
            ]
          },
          {
            title: "TypeScript",
            items: [
              {
                label: "Docs",
                href: "/docs/category/typescript"
              },
              {
                label: "GitHub",
                href: "https://github.com/git-filesystem/git-filesystem.js"
              },
              {
                label: "npm",
                href: "https://www.npmjs.com/package/git-filesystem"
              }
            ]
          },
          {
            title: "C#",
            items: [
              {
                label: "To-Do",
                to: "/"
              }
            ]
          }
        ],
        copyright: `Copyright © ${new Date().getFullYear()} Git-FileSystem.`
      },
      prism: {
        theme: require("prism-react-renderer").themes.github,
        darkTheme: require("prism-react-renderer").themes.vsDark
      }
    })
};

module.exports = config;