DesignPatternPedia/docusaurus.config.ts at main · S7-OpenLearning-Individual/DesignPatternPedia · 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
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import packageJson from "./package.json";
import "dotenv/config";

const baseUrlOrDefault = process.env.BASE_URL || "/";
const useAdvancedSearch = process.env.SEARCH === "ADVANCED";

const config: Config = {
  title: "Design Pattern Pedia",
  tagline: "Practicing Patterns Made Plain and Practical",
  favicon: "img/favicon.ico",
  future: {
    v4: true,
  },
  url: "https://your-docusaurus-site.example.com",
  baseUrl: baseUrlOrDefault,
  customFields: {
    // We need to pass this directly as process.env is not available in the client bundle. But we do need this variable in the client bundle.
    baseUrl: baseUrlOrDefault,
  },
  organizationName: "S7-OpenLearning-Individual",
  projectName: "DesignPatternPedia",
  onBrokenLinks: "throw",
  i18n: {
    defaultLocale: "en",
    locales: ["en"],
  },
  markdown: {
    mermaid: true,
  },
  presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
          editUrl:
            "https://github.com/S7-OpenLearning-Individual/DesignPatternPedia/tree/main/",
        },
        blog: false,
        theme: {
          customCss: "./src/css/custom.css",
        },
      } satisfies Preset.Options,
    ],
  ],
  themes: [
    "@docusaurus/theme-live-codeblock",
    ...(useAdvancedSearch
      ? []
      : [
          [
            require.resolve("@easyops-cn/docusaurus-search-local"),
            {
              hashed: true,
              indexDocs: true,
              indexPages: true,
              indexBlog: false,
            },
          ],
        ]),
    "@docusaurus/theme-mermaid",
  ],
  themeConfig: {
    ...(useAdvancedSearch
      ? {
          algolia: {
            appId: "QFVS6MUVRT",
            apiKey: "cafb35d52858566ca1ff1cabdb161d4c",
            indexName: "YOUR_INDEX_NAME",
            contextualSearch: true,
            searchPagePath: "search",
          },
        }
      : {}),
    image: "img/docusaurus-social-card.jpg",
    colorMode: {
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: "Design Pattern Pedia",
      logo: {
        alt: "Design Pattern Pedia Logo",
        src: "img/logo.svg",
      },
      items: [
        {
          position: "left",
          to: "/docs/overview",
          label: "Overview",
        },
        {
          position: "left",
          to: "/docs/navigator",
          label: "Navigator",
        },
        {
          position: "left",
          to: "docs/behavioral",
          label: "Behavioral",
        },
        {
          position: "left",
          to: "docs/creational",
          label: "Creational",
        },
        {
          position: "left",
          to: "docs/structural",
          label: "Structural",
        },
        { to: "/manifest", label: "Manifesto", position: "left" },
        {
          href: "https://github.com/S7-OpenLearning-Individual/DesignPatternPedia",
          label: "GitHub",
          position: "right",
        },
      ],
    },
    footer: {
      style: "dark",
      links: [
        {
          title: "Contribute & Feedback",
          items: [
            {
              label: "GitHub",
              href: "https://github.com/S7-OpenLearning-Individual/DesignPatternPedia",
            },
          ],
        },
      ],
      copyright: `Made by Joris Brugman | v${packageJson.version}`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },
  } satisfies Preset.ThemeConfig,
};

export default config;