接口说明
站点配置与接口说明。
Astro +
import.meta.glob驱动的文档站点。以下说明涵盖配置方式。
URL 结构
| 路径 | 说明 |
|---|---|
/ | 首页 |
/docs/getting-started | 快速开始 |
/docs/dev/architecture | 架构设计 |
/docs/dev/api-reference | 接口说明(本页) |
/docs/dev/secret | 机密文档(构建后为密码页) |
_meta.ts 配置
顶层 src/content/docs/_meta.ts 定义侧边栏:
import type { MetaEntry } from '../../lib/sidebar'
const meta: MetaEntry[] = [
{ label: '架构设计', slug: 'dev/architecture' },
{ label: '接口说明', slug: 'dev/api-reference' },
]
export default meta
类型
interface MetaItem {
label: string // 侧边栏显示名
slug: string // 对应的文档路径(相对 src/content/docs/,不含 .mdx)
}
interface MetaGroup {
label: string // 分组标题
slug?: string // 可选,用作 DOM id;缺省从 label 生成
items: MetaItem[] // 分组下的子项
}
type MetaEntry = MetaItem | MetaGroup
label 与 slug 在渲染时会做 HTML 转义;分组 DOM id 冲突时自动追加序号。
页面 Frontmatter
每个 .mdx 文件仅需:
---
title: 页面标题
description: 可选描述(SEO)
---
无需指定 layout——由 [...slug].astro 统一交给 DocsLayout 处理。
环境变量
| 变量 | 用途 |
|---|---|
STATICRYPT_PASSWORD | 加密 docs/dev/secret 的密码,构建时必填(.env 或 CI secret) |
添加流程
- 在对应目录创建
.mdx - 在
src/content/docs/_meta.ts加一行配置 - 完成,构建后自动生效