matrixplugin.github.io/docusaurus.config.ts at main · MatrixPlugin/matrixplugin.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

const config: Config = {
  title: 'Matrix Wiki',
  tagline: 'Matrix 系列插件官方文档',
  favicon: 'img/logo.svg',
  future: {
    v4: true,
  },
  url: 'https://matrixplugin.github.io',
  baseUrl: '/',
  organizationName: 'MatrixPlugin',
  projectName: 'matrixplugin.github.io',
  deploymentBranch: 'main',
  onBrokenLinks: 'throw',
  i18n: {
    defaultLocale: 'zh-Hans',
    locales: ['zh-Hans'],
  },
  customFields: {
    aiSearch: {
      provider: 'deepseek',
      endpoint: 'https://api.deepseek.com/chat/completions',
      model: 'deepseek-chat',
      storageKey: 'matrixWiki.deepseekApiKey',
    },
  },
  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          editUrl: 'https://github.com/MatrixPlugin/matrixplugin.github.io/tree/main/',
          showLastUpdateAuthor: true,
          showLastUpdateTime: true,
          exclude: ['**/tutorial-basics/**', '**/tutorial-extras/**'],
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],
  plugins: [
    [
      '@easyops-cn/docusaurus-search-local',
      {
        docsRouteBasePath: '/docs',
        indexBlog: false,
        indexPages: false,
        language: ['zh', 'en'],
        hashed: true,
        highlightSearchTermsOnTargetPage: true,
        explicitSearchResultPath: true,
        searchBarShortcut: true,
        searchBarShortcutKeymap: 'mod+k',
        searchBarPosition: 'right',
        searchResultLimits: 8,
        searchResultContextMaxLength: 100,
      },
    ],
  ],
  themeConfig: {
    image: 'img/logo.svg',
    metadata: [
      {
        name: 'description',
        content: 'MatrixAuth、MatrixCook、MatrixShop 官方文档，包含插件索引、本地搜索与 AI 搜索入口。',
      },
      {
        name: 'keywords',
        content: 'MatrixAuth, MatrixCook, MatrixShop, Minecraft, Paper, Bukkit, 插件文档',
      },
      {
        property: 'og:description',
        content: 'Matrix 系列插件官方文档站点，覆盖概览、安装、配置、命令与常见问题。',
      },
    ],
    colorMode: {
      defaultMode: 'light',
      disableSwitch: false,
      respectPrefersColorScheme: true,
    },
    docs: {
      sidebar: {
        hideable: true,
      },
    },
    navbar: {
      title: 'Matrix Wiki',
      logo: {
        alt: 'Matrix Wiki Logo',
        src: 'img/logo.svg',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'docsSidebar',
          position: 'left',
          label: '文档目录',
        },
        {to: '/docs/matrixauth/overview', label: 'MatrixAuth', position: 'left'},
        {to: '/docs/matrixcook/overview', label: 'MatrixCook', position: 'left'},
        {to: '/docs/matrixshop', label: 'MatrixShop', position: 'left'},
        {to: '/docs/matrixstorage', label: 'MatrixStorage', position: 'left'},
        {type: 'search', position: 'right'},
        {to: '/ai-search', label: 'AI 搜索', position: 'right'},
        {
          href: 'https://github.com/MatrixPlugin/matrixplugin.github.io',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'light',
      links: [
        {
          title: '文档',
          items: [
            {
              label: '站点总览',
              to: '/docs/intro',
            },
            {
              label: '插件列表',
              to: '/docs/plugins',
            },
            {
              label: 'AI 搜索',
              to: '/ai-search',
            },
          ],
        },
        {
          title: '插件',
          items: [
            {
              label: 'MatrixAuth',
              to: '/docs/matrixauth/overview',
            },
            {
              label: 'MatrixCook',
              to: '/docs/matrixcook/overview',
            },
            {
              label: 'MatrixShop',
              to: '/docs/matrixshop',
            },
            {
              label: 'MatrixStorage',
              to: '/docs/matrixstorage',
            },
          ],
        },
        {
          title: '仓库',
          items: [
            {
              label: 'matrixplugin.github.io',
              href: 'https://github.com/MatrixPlugin/matrixplugin.github.io',
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} 54895y. Built with Docusaurus.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
    },
  } satisfies Preset.ThemeConfig,
};

export default config;