# bboxdocs

**Repository Path**: daoges_x/bboxdocs

## Basic Information

- **Project Name**: bboxdocs
- **Description**: Bbox官方文档仓库，可提交pr进行维护
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-17
- **Last Updated**: 2026-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Bbox 文档仓库

这个仓库用于维护 Bbox 官网的公开文档内容。网站文档页基于 **Docsify 4 + Markdown** 渲染，官网服务会把本仓库同步到服务器后，以独立文档站的形式展示。

线上入口由官网导航栏打开，路径是 `/bbox-docs/`。文档站运行资源由官网服务本地提供，不依赖 CDN。

## 仓库结构

```text
.
├── docs/                 # 公开文档内容，Docsify 会读取这里
│   ├── README.md         # 文档站首页
│   ├── _sidebar.md       # Docsify 左侧导航，人工维护
│   ├── quick-start.md
│   ├── plugin-sync.md
│   ├── route-nfc.md
│   ├── upgrade-formal.md
│   └── release-history.md
├── meta.json             # 后台预览和兜底排序用
└── README.md             # 本仓库维护说明
```

## 写作语法

文档正文使用标准 Markdown，并兼容 Docsify 常用写法。

- 页面文件放在 `docs/` 目录。
- 文档站首页写在 `docs/README.md`。
- 左侧导航写在 `docs/_sidebar.md`。
- 页面链接使用相对 slug，例如 `[插件同步](plugin-sync)`。
- 图片建议放在 `docs/assets/`，引用方式示例：`![说明](assets/example.png)`。
- 不要在文档里引入外部 CDN 脚本或样式。

页面顶部可以保留 frontmatter，方便后台预览、搜索和兜底排序：

```md
---
title: 快速开始
chapter: 入门
summary: 安装、登录、同步插件和上传日志的基础流程。
order: 1
---

# 快速开始

正文内容。
```

## 推送规则

1. 从 `main` 新建分支修改文档。
2. 修改或新增页面后，同步更新 `docs/_sidebar.md`。
3. 如果希望后台预览顺序也同步更新，同时维护 `meta.json`。
4. 提交信息使用清晰中文，例如 `更新插件同步文档`。
5. 推送到远端后发起合并请求，或由维护者直接合并到 `main`。
6. 正式发布文档版本时，由维护者打 `x.y.z` 格式 tag，例如 `1.0.0`。

```bash
git checkout -b docs/update-plugin-sync
git add docs meta.json
git commit -m "更新插件同步文档"
git push origin docs/update-plugin-sync
```

发布版本示例：

```bash
git checkout main
git pull --ff-only
git tag 1.0.0
git push origin main
git push origin 1.0.0
```

服务器同步 `main` 后，网站会读取最新 Markdown。文档内容更新通常不需要重启官网服务。

## 敏感信息规则

这个仓库计划公开，禁止提交任何敏感信息。

- 不提交服务器 IP 的登录凭证、SSH 私钥、`.pem` 文件。
- 不提交后台 token、Webhook token、Cookie、SMTP 授权码、数据库密码。
- 不提交 `.env`、`.env.local`、本地部署脚本里的真实密钥。
- 如需说明配置项，只提交 `.env.example` 或文档占位符，例如 `<server-only-token>`。

提交前建议执行：

```bash
git status
git diff --cached
```

确认没有密钥、账号密码、Cookie、授权码后再推送。