跳到主要内容
版本:Current

cssadoc 文档站

BU CSSA 技术部官方文档中心 — 基于 Docusaurus 3 的静态文档网站,托管于 Cloudflare Workers。

本目录说明文档站本身的架构、写作规范与维护方式。各业务系统文档见侧边栏「项目文档」下的对应条目。

文档导航​

分类说明入口
概览站点定位、功能、架构与技术栈项目介绍
入门指南本地安装与第一次预览安装
用户指南文档结构、写作规范、侧边栏配置文档结构
配置Docusaurus 与站点配置项Docusaurus 配置
部署指南本地预览与 Cloudflare 生产部署环境要求
开发者指南仓库目录与 Docusaurus 架构项目结构
参与贡献开发环境与提交流程开发环境
故障排查构建与部署常见问题常见错误
常见问题FAQ 一览FAQ

推荐阅读顺序​

维护文档站的成员

  1. Introduction → Documentation Structure
  2. Writing New Docs → Sidebar and Navigation
  3. Development Setup → Production Deployment

只想本地预览的成员

  1. Installation → Quick Start

技术栈摘要​

Docusaurus 3 · React 19 · TypeScript · Mermaid · i18n(中/英)· Cloudflare Workers(Wrangler)

完整版本与依赖见 技术栈。

上游与参考​

本文档描述部内如何维护文档站;Docusaurus、React、Wrangler 等配置与 API 细节请查上游官方文档。

项目官方文档源码
Docusaurusdocusaurus.io/docsfacebook/docusaurus
Reactreact.devfacebook/react
Wrangler / WorkersCloudflare Workerscloudflare/workers-sdk
Mermaidmermaid.js.orgmermaid-js/mermaid