zlua-doc/docusaurus.config.ts at main · focus-creative-games/zlua-doc · 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
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: 'ZLua Docs',
  tagline: 'Unity Il2Cpp 极致优化的现代原生 Lua 方案',

  // favicon: 'img/favicon.ico',

  future: {
    v4: true,
  },

  url: 'https://doc.zlua.cn',
  baseUrl: '/',

  organizationName: 'focus-creative-games',
  projectName: 'zlua-doc',

  onBrokenLinks: 'warn',
  onBrokenMarkdownLinks: 'warn',

  i18n: {
    defaultLocale: 'zh-CN',
    // 英文文档：添加 'en' 至 locales 并创建 i18n/en/ 翻译文件（P5 预留）
    locales: ['zh-CN'],
  },

  markdown: {
    format: 'detect',
    mermaid: true,
  },

  themes: ['@docusaurus/theme-mermaid'],

  plugins: [
    [
      require.resolve('@easyops-cn/docusaurus-search-local'),
      {
        hashed: true,
        language: ['zh', 'en'],
        highlightSearchTermsOnTargetPage: true,
        explicitSearchResultPath: true,
      },
    ],
  ],

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          editUrl: 'https://github.com/focus-creative-games/zlua-doc/tree/main/',
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    image: 'img/zlua-social-card.jpg',
    colorMode: {
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: 'ZLua Docs',
      logo: {
        alt: 'ZLua Logo',
        src: 'img/logo.svg',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'docsSidebar',
          position: 'left',
          label: '文档',
        },
        {
          type: 'docSidebar',
          sidebarId: 'architectureSidebar',
          position: 'left',
          label: '架构',
        },
        {
          href: 'https://github.com/focus-creative-games/zlua-demo',
          label: 'Demo',
          position: 'right',
        },
        {
          href: 'https://github.com/focus-creative-games/zlua',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: '文档',
          items: [
            {label: '快速开始', to: '/docs/getting-started/quick-start'},
            {label: '使用指南', to: '/docs/guides/csharp-to-lua'},
            {label: 'API 参考', to: '/docs/reference/overview'},
          ],
        },
        {
          title: '社区',
          items: [
            {
              label: 'GitHub Issues',
              href: 'https://github.com/focus-creative-games/zlua/issues',
            },
            {
              label: 'Discord',
              href: 'https://discord.gg/htmr44jW6A',
            },
            {label: '联系与 FAQ', to: '/docs/community/contact'},
          ],
        },
        {
          title: '更多',
          items: [
            {
              label: 'ZLua 源码',
              href: 'https://github.com/focus-creative-games/zlua',
            },
            {
              label: '示例项目',
              href: 'https://github.com/focus-creative-games/zlua-demo',
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} Code Philosophy. ZLua 采用 MIT 许可证。`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['csharp', 'lua'],
    },
    mermaid: {
      theme: {light: 'neutral', dark: 'dark'},
    },
  } satisfies Preset.ThemeConfig,
};

export default config;