跳到主要内容
版本:Current

Docusaurus 配置

主配置文件

docusaurus.config.ts 为站点核心配置,以下为与日常维护相关的字段。

站点基本信息

字段当前值说明
titleBU CSSA 技术部文档站浏览器标题、OG 标题
tagline技术部官方文档中心首页副标题
faviconimg/bucssalogo.png位于 static/img/
url生产域名部署前需改为实际 URL
baseUrl/子路径部署时修改

Markdown 与 Mermaid

markdown: {
mermaid: true,
},
themes: ['@docusaurus/theme-mermaid'],

启用后,任意 docs/blog 的 Markdown 代码块语言设为 mermaid 即可渲染图表。

国际化

i18n: {
defaultLocale: 'zh-Hans',
locales: ['zh-Hans', 'en'],
},
locale说明
zh-Hans默认语言,主文档源
en英文,翻译文件在 i18n/en/

Docs 插件

选项说明
sidebarPath./sidebars.ts侧边栏定义
lastVersioncurrent默认打开的版本
versions.current.labelCurrent版本下拉显示名
versions.v1.labelV1.0历史版本

Blog 插件

选项说明
routeBasePath: 'blog'Blog 路由前缀
showReadingTime: true显示阅读时间
feedOptions.typeRSS + Atom

themeConfig 要点

  • 文档docSidebar,sidebarId docs
  • Blog:链至 /blog
  • 版本下拉docsVersionDropdown
  • 语言切换localeDropdown

「相关链接」列出 BUCSSA 官网、Portal、网盘、抽奖、GPT 等外部 URL。

其他

选项
onBrokenLinkswarn
colorMode.respectPrefersColorSchemetrue
future.v4true(Docusaurus v4 兼容)

Wrangler 配置

wrangler.jsonc

字段说明
namebucssa-documentationWorkers 服务名
assets.directorybuild指向 Docusaurus 构建输出
compatibility_date日期Workers 运行时兼容日期

修改配置的注意点

  • 修改 docusaurus.config.ts 后需重启 dev server
  • 修改 url / baseUrl 会影响 sitemap 与 canonical URL
  • editUrl 当前仍指向 Docusaurus 模板地址,建议改为本仓库 GitHub 路径以便「编辑此页」功能