docs/docusaurus.config.ts at main · pelican-dev/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
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import tailwindPlugin from "./src/plugins/tailwind-config.cjs";
import remarkgfm from "remark-gfm";

const config: Config = {
  title: "Pelican",
  tagline: "From prehistoric to peak performance: Pelican takes flight!",
  favicon: "img/favicon.ico",
  markdown: {
    mermaid: true,
    hooks: {
      onBrokenMarkdownLinks: "warn",
    }
  },
  url: "https://pelican.dev",
  baseUrl: "/",
  organizationName: "pelican-dev",
  projectName: "docs",
  onBrokenLinks: "throw",
  themes: ["@docusaurus/theme-mermaid"],
  presets: [
    [
      "classic",
      {
        docs: {
          sidebarPath: "./sidebars.ts",
          editUrl: "https://github.com/pelican-dev/docs/blob/main/",
          remarkPlugins: [remarkgfm],
        },
        theme: {
          customCss: [
            require.resolve("./src/css/tailwind.css"),
            require.resolve("./src/css/custom.scss"),
          ],
        },
      } satisfies Preset.Options,
    ],
  ],
  themeConfig: {
    navbar: {
      title: "Pelican",
      logo: {
        src: "img/logo.png",
      },
      items: [
        { to: "/docs", label: "Docs", position: "left" },
        { to: "/support", label: "Support", position: "left" },
        { to: "/faq", label: "FAQ", position: "left" },
        { to: "/hub", label: "Hub", position: "left", target: "_blank", },
        { to: "/eggs", label: "Eggs", position: "left", target: "_blank", },
        { to: "/github", position: "right", className: "github-link", target: "_blank", },
        { to: "/discord", position: "right", className: "discord-link", target: "_blank", },
      ],
    },
    colorMode: {
      defaultMode: "dark",
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    footer: {
      logo: {
        src: "img/logo.png",
        height: "64px",
        width: "64px",
      },
      style: "dark",
      links: [
        {
          title: 'Documentation',
          items: [
            {
              label: 'Panel',
              to: '/docs/panel/getting-started',
            },
            {
              label: 'Wings',
              to: '/docs/wings/install',
            },
            {
              label: 'SSL Setup',
              to: '/docs/guides/ssl'
            },
          ],
        },
        {
          title: "Community",
          items: [
            { label: "Discord", to: "/discord", target: "_blank", },
            { label: "GitHub", to: "/github", target: "_blank", },
          ],
        },
      ],
      copyright: `Copyright © 2024 - ${new Date().getFullYear()} Pelican`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: [
        "bash",
        "nginx",
        "apacheconf",
        "ini",
        "sql",
        "yaml",
        "docker",
        "php",
      ],
    },
  } satisfies Preset.ThemeConfig,
  plugins: [
    [
      require.resolve('@docusaurus/plugin-client-redirects'),
      {
        redirects: [
          { from: '/discord', to: 'https://discord.gg/pelican-panel' },
          { from: '/eggs', to: 'https://pelican-eggs.github.io/pelican' },
          { from: '/github', to: 'https://github.com/pelican-dev/panel' },
          { from: '/hub', to: 'https://hub.pelican.dev' },
          { from: '/donate', to: 'https://pelican.dev/support' },
        ],
      },
    ],
    require.resolve('docusaurus-lunr-search'),
    "docusaurus-plugin-sass",
    tailwindPlugin,
  ],
  future: {
    experimental_faster: true,
    v4: true
  },
  // scripts: ['/js/snowflake.min.js'],
};

export default config;