本仓库为 宝塔面板（BT Panel） 与 堡塔域名服务 的官方文档源码，构建后部署在 docs.bt.cn。
欢迎参与宝塔面板文档的编写，贡献方式如下：
- Fork本仓库
- 在
docs目录下编写文档 - 提交Pull Request
git clone https://cnb.cool/btpanel/docs.git
# 链接请替换为fork后仓库地址
npm install
npm run start
写在前面 — 面向 AI 与搜索引擎（GEO）的硬性要求
本文档站会被 ChatGPT、Perplexity、百度/Google 等 AI 与搜索引擎抓取并用于回答用户问题。为保证宝塔面板（BT Panel）这一品牌实体被正确识别与引用，新增或修改任何文档时，必须遵守下方「frontmatter 规范」与「正文结构规范」。
每篇 .md 文档文件开头必须包含完整的 YAML frontmatter，示例：
---
sidebar_position: 1
title: 在宝塔面板中部署 SSL 证书 # 与正文 H1 一致；含核心实体词
description: 详细介绍如何在宝塔面板（BT Panel）中为站点申请 Let's Encrypt 免费 SSL 证书并配置自动续期，适用于 Linux 与 Windows 面板。 # 80–140 字，一句话描述「做什么 + 给谁用 + 解决什么问题」，必须含「宝塔面板」或「BT Panel」
keywords: [宝塔面板, BT Panel, SSL 证书, Let's Encrypt, HTTPS] # 3–10 个，覆盖核心实体与场景词
tags: [SSL, 证书, 安全] # 与 keywords 不同：tags 用于站内分类聚合
---
| 字段 | 是否必填 | 要求 |
|---|---|---|
title | 推荐 | 缺省时使用正文 H1；建议包含「宝塔面板」或「BT Panel」 |
description | 必填 | 80–140 字完整句，严禁 写成「安装面板」「修改密码」这种 4–6 字流水标签；必须出现一次「宝塔面板」或「BT Panel」 |
keywords | 必填 | 3–10 个数组项，覆盖产品名（宝塔面板/BT Panel）+ 核心功能词 + 场景词 |
tags | 推荐 | 用于站内分类聚合，与 keywords 区分 |
sidebar_position | 视情况 | 控制侧边栏排序 |
⚠️ description 是 AI 抓取时的首选摘要字段，写得好直接决定本文是否会被 AI 引用。范本参见 docs/faq/panel-not-show.md、docs/faq/connect-error.md。
- H1 唯一：每篇文档有且仅有一个一级标题（
#），需包含核心实体词。例如「在宝塔面板中安装 Docker」而不是「安装 Docker」。 - 首段为 TL;DR：H1 之后必须有 1–3 句概述段（What + Who + Outcome），让 AI 抓取首段就能拿到完整含义。不要直接进入「## 操作场景」。
- 推荐范式：「本文介绍如何在【宝塔面板（BT Panel）】中【做什么】，适用于【哪些用户/场景】，完成后将获得【什么结果】。」
- 品牌全称：每篇文档 H1 + 首段至少出现一次「宝塔面板（BT Panel）」全称，避免被切片后失去实体上下文。
- 章节层级：使用
##/###/####，最多 4 级。每个##章节建议 200–800 字。 - 末尾「常见问题 / 相关文档」（推荐）：操作类教程（getting-started、practical-tutorials）建议在末尾加：
## 常见问题 ### Q: ... A: ... ## 相关文档 - [文档 A](path) - [文档 B](path)
- 图片必须有非空 alt 文本：
，禁止。alt 内容写一句话说明截图含义。 - 代码块必须标注语言：
```bash/```nginx/```yaml/```sql，禁止裸```。 - 大段截图前后 都需有文字说明，避免连续 3 张以上无文字间隔截图。
宝塔面板的英文缩写「BT」常被 AI 误识别为 BitTorrent。撰写文档时：
- 优先使用「宝塔面板（BT Panel）」全称，至少在 H1 与首段各出现一次；
- 不要单独使用「BT」指代产品；如必要请写「BT Panel」（保留 Panel 后缀）；
- 涉及命令行工具时使用反引号
`bt`（小写、内联代码格式），与品牌名区分开。
提交前可运行以下脚本检查 frontmatter 完整度与空 alt 等问题：
node scripts/audit-docs.js
输出示例（数字越小越好）：
{ "total": 362, "noFrontmatter": 0, "shortDescription": 0, "noKeywords": 0, "emptyAlt": 0 }
本节规范宝塔面板所有对外文档（包括但不限于产品文档、API 文档、白皮书等）的基本格式与风格。文档书写语法为 Markdown，详见 https://github.github.com/gfm/。
注：本标准参考腾讯云文档写作规范。
| 总体方针 | 以解决用户问题为目标，注重场景化。 遵循5W1H分析法： （What）这是什么产品？ （Who）针对哪些客户群体？ （Why）我为什么要使用这个产品？这个产品解决什么问题？ （When+Where）使用产品的具体场景是什么？ （How）怎么使用这个产品？
|
| 基本方法论 | 关注一致性、准确性（上下文、文字、标点符号与图片） 把可能使用的名词、缩略语都在文首列出，避免文档中出现从未见过的名词。注意标点的正确使用，截图中出现的文字与说明需保持强一致性。 例子：堡塔企业级防篡改（又称防篡改） |
| 清晰、易读 关注文档结构，构建易读的索引。 多使用图、表，增强易懂性。同时注意图表的清晰度，规范统一的图表风格 |
宝塔面板在线文档均在Github统一编辑发布，采用Markdown编写方式，文档中的的字体、颜色请保持默认风格，不要使用特殊字体、颜色。 宝塔面板离线文档统一为PDF格式，请使用Markdown编辑器编写，有形如以上的规范。
文档标题有形如下的格式规范，目录从一级开始，最多可到第三级。（三级以上的标题不符合常规阅读需求，请拆分或使用标题内的列表进行相应处理）
| 标题层级 | 显示样式 | Markdown语法 |
|---|---|---|
| 第一级标题 | ## 第一级标题 | Markdown请注意采用二级‘##’语法，对应Word字号为22.5 |
| 第二级标题 | ### 第二级标题 | Markdown请注意采用三级‘###’语法，对应Word字号为17.5 |
| 第三级标题 | #### 第三级标题 | Markdown请注意采用四级‘####’语法，对应Word字号为13 |
内容列表有形如下的格式规范：
| 列表层级 | 显示样式 |
|---|---|
| 正文第一级列表 | 1. 列表项一 2. 列表项二 |
| 列表中的第二级列表 | 1. 列表项一 这是一段说明 1) 二级列表项一 2) 二级列表项二 |
| 二级列表中的第三级列表 | 1. 列表项一 这是一段说明 1) 二级列表项一 这是另一段说明 A. 三级列表项1 B. 三级列表项2 2) 二级列表项二 |
| 特殊表达 | 表达方式 | 说明 |
|---|---|---|
| 强调 | 粗体+斜体+前后空格 | 非普通文字和短语或重要文字和短语的特殊标记。
|
| 正文中的参数、表达式或代码 | 内联代码 | 必须使用内联代码标识正文中的参数、表达式或代码。Markdown语法为 `` |
| 代码块 | 文档中出现的完整代码 | 与正文分开，使用代码块标识。Markdown语法为``` ``` |
| 界面标志 | 【中文方括号】 | 标识 UI 上的指定内容以便识别。 在【云服务器】选项卡中，点击【新建】按钮。 |
| 交叉引用/外链 | 超链接 | 多使用超链接进行文档间关系的建立。 产品文档中引用的链接地址请统一直接拷贝磐石产品文档中的相对路径，/document/product/ +数字路径，例如/document/product/213/6090。 |
| 互斥参数 | (圆括号 | 和 | 竖 | 线) | 代码中，分割线表示必须从中选择一个选项的选项集。 % data = hdfread (start | stride | edge) |
| 可选参数 | [英文方括号] | 代码中，方括号表示完全可选的命令或参数。 ssh [-l, -q] root@10.10.10.10 |
| 变量 | <箭头括号> | 代码中，箭头括号表示必须替换为有效值的变量。 mount /dev/vdb1 %<%your-mountpoint> |
- 一定多检查，确保没有错别字。即使是流行语中的谐音错别字也不要使用，比如”墙裂”、”童鞋”、“程序猿”等。
- 段落之间使用一个空行隔开。段落开头 不要 留出空白字符。
- 请把对表达意思没有明显作用的字、词、句删除，在不影响表达效果的前提下把文案长度减到最短。
- 避免口语，使用规范的书面语。例子：避免使用“么”、“喔”、“挂掉”等口语词汇。
- 尽量避免中英文混杂。
- 请一定注意“的”、“地”、“得”的用法。
- 第一人称：推荐使用“宝塔面板”、“我们”，不推荐使用“小编”、“笔者”。
- 避免多介词的复合长句。注意句子成分要齐全。
例如： 改前：对于apt-get下载源，不需要添加软件源，可以直接安装软件包。为了加速软件安装，目前系统已经在内网预先配置了Ubuntu的mirror，这个mirror是官网x86_64的完全镜像，与官网源一致。
改后：对于apt-get下载源，不需添加软件源则可直接安装软件包。为了加速软件安装，腾讯云已在内网预先配置了Ubuntu的x86_64完全镜像，与官方源一致。
- 英文与非标点的中文之间需要有一个空格。如“使用宝塔一键迁移 API 版本迁移网站”而不是“使用宝塔一键迁移API版本迁移网站”。
- 尽可能使用中文数词，特别是当前后都是中文时。例如：“我们发布了五个产品”。
- 只有中文或中英文混排中，一律使用中文 / 全角标点
- 中英文混排中如果出现整句英文，则在这句英文中使用英文 / 半角标点。
- 省略号：请使用”……“标准用法，不要使用”。。。“。
- 感叹号：请勿使用”！！“。尽量避免使用”！“。请先冷静下来再坐电脑前敲键盘。
- 波浪号：请勿在文章内使用“~”，活泼地卖萌有很多其他的表达方式。
| 正确使用 | 错误使用 |
| App / 应用 | APP、软件、程序 |
| Android | android、安卓 |
| iOS | ios、IOS |
| iPhone | IPHONE、iphone |
| App Store | AppStore、app store |
| WiFi | wifi、Wifi、Wi-fi |
| E-mail、Email | |
| IP | Ip、ip |
