cssadoc 文档站
BU CSSA 技术部官方文档中心 — 基于 Docusaurus 3 的静态文档网站,托管于 Cloudflare Workers。
本目录说明文档站本身的架构、写作规范与维护方式。各业务系统文档见侧边栏「项目文档」下的对应条目。
文档导航
| 分类 | 说明 | 入口 |
|---|---|---|
| 概览 | 站点定位、功能、架构与技术栈 | 项目介绍 |
| 入门指南 | 本地安装与第一次预览 | 安装 |
| 用户指南 | 文档结构、写作规范、侧边栏配置 | 文档结构 |
| 配置 | Docusaurus 与站点配置项 | Docusaurus 配置 |
| 部署指南 | 本地预览与 Cloudflare 生产部署 | 环境要求 |
| 开发者指南 | 仓库目录与 Docusaurus 架构 | 项目结构 |
| 参与贡献 | 开发环境与提交流程 | 开发环境 |
| 故障排查 | 构建与部署常见问题 | 常见错误 |
| 常见问题 | FAQ 一览 | FAQ |
推荐阅读顺序
维护文档站的成员
- Introduction → Documentation Structure
- Writing New Docs → Sidebar and Navigation
- Development Setup → Production Deployment
只想本地预览的成员
技术栈摘要
Docusaurus 3 · React 19 · TypeScript · Mermaid · i18n(中/英)· Cloudflare Workers(Wrangler)
完整版本与依赖见 技术栈。
上游与参考
本文档描述部内如何维护文档站;Docusaurus、React、Wrangler 等配置与 API 细节请查上游官方文档。
| 项目 | 官方文档 | 源码 |
|---|---|---|
| Docusaurus | docusaurus.io/docs | facebook/docusaurus |
| React | react.dev | facebook/react |
| Wrangler / Workers | Cloudflare Workers | cloudflare/workers-sdk |
| Mermaid | mermaid.js.org | mermaid-js/mermaid |