项目结构

AR Docs 项目遵循 Astro 的标准目录结构,并在此基础上扩展了文档管理功能。

根目录

ardocs/
├── docs/                  # 用户文档目录
├── src/                   # 源代码
├── public/                # 静态资源
├── functions/             # Cloudflare Workers
├── astro.config.mjs       # Astro 配置
├── wrangler.jsonc         # Cloudflare 配置
├── package.json           # 项目依赖
└── tsconfig.json          # TypeScript 配置

src 目录

src/
├── components/            # 可复用组件
│   ├── Header.astro       # 顶部导航
│   ├── Footer.astro       # 页脚
│   ├── Sidebar.astro      # 侧边栏
│   └── ...
├── content.config.ts      # 内容集合配置
├── layouts/               # 布局组件
│   └── DocsLayout.astro   # 文档布局
├── pages/                 # 页面路由
│   ├── index.astro        # 首页
│   └── [lang]/            # 多语言路由
│       └── docs/
│           └── [...slug].astro
├── plugins/               # 自定义插件
│   └── shiki-code-transformer.ts
└── styles/                # 样式文件
    ├── global.css         # 全局样式
    └── variables.css      # CSS 变量

docs 目录

用户文档存放位置,支持 .mdx 格式:

docs/
├── _template.mdx          # 文档模板
├── getting-started.mdx    # 快速开始
├── installation.mdx       # 安装指南
├── project-structure.mdx  # 项目结构
├── routing.mdx            # 路由系统
├── styling.mdx            # 样式系统
├── components.mdx         # 组件使用
├── api.mdx                # API 参考
├── faq.mdx                # 常见问题
├── env-vars.mdx           # 环境变量
├── cloudflare.mdx         # Cloudflare 部署
└── private-guide.mdx      # 私有化部署

关键文件

文件说明
astro.config.mjsAstro 框架配置
src/content.config.ts内容集合 schema 定义
src/plugins/shiki-code-transformer.ts代码块高亮插件
wrangler.jsoncCloudflare Workers 配置

提示

内容集合文件必须放在 src/content.config.ts(Astro v6),而非 src/content/config.ts