diff --git a/.contributing/img/authorize-github.png b/.contributing/img/authorize-github.png deleted file mode 100755 index ee31d2b..0000000 Binary files a/.contributing/img/authorize-github.png and /dev/null differ diff --git a/.contributing/img/ci-failed.png b/.contributing/img/ci-failed.png deleted file mode 100755 index 7c10422..0000000 Binary files a/.contributing/img/ci-failed.png and /dev/null differ diff --git a/.contributing/img/ci-preview.png b/.contributing/img/ci-preview.png deleted file mode 100755 index e53ec4c..0000000 Binary files a/.contributing/img/ci-preview.png and /dev/null differ diff --git a/.contributing/img/compare-changes.png b/.contributing/img/compare-changes.png deleted file mode 100755 index 94a3ffc..0000000 Binary files a/.contributing/img/compare-changes.png and /dev/null differ diff --git a/.contributing/img/download-full-content.png b/.contributing/img/download-full-content.png deleted file mode 100755 index f0bffb2..0000000 Binary files a/.contributing/img/download-full-content.png and /dev/null differ diff --git a/.contributing/img/fetch-and-merge.png b/.contributing/img/fetch-and-merge.png deleted file mode 100755 index 35b72d0..0000000 Binary files a/.contributing/img/fetch-and-merge.png and /dev/null differ diff --git a/.contributing/img/forked.png b/.contributing/img/forked.png deleted file mode 100755 index fa189e7..0000000 Binary files a/.contributing/img/forked.png and /dev/null differ diff --git a/.contributing/img/git-commit.png b/.contributing/img/git-commit.png deleted file mode 100755 index e3351f5..0000000 Binary files a/.contributing/img/git-commit.png and /dev/null differ diff --git a/.contributing/img/git-stage.png b/.contributing/img/git-stage.png deleted file mode 100755 index 4f9e6a3..0000000 Binary files a/.contributing/img/git-stage.png and /dev/null differ diff --git a/.contributing/img/github-dev-search.png b/.contributing/img/github-dev-search.png deleted file mode 100755 index 7ad421e..0000000 Binary files a/.contributing/img/github-dev-search.png and /dev/null differ diff --git a/.contributing/img/github-fork.png b/.contributing/img/github-fork.png deleted file mode 100755 index 6718dde..0000000 Binary files a/.contributing/img/github-fork.png and /dev/null differ diff --git a/.contributing/img/github-preview.png b/.contributing/img/github-preview.png deleted file mode 100755 index 2b6c653..0000000 Binary files a/.contributing/img/github-preview.png and /dev/null differ diff --git a/.contributing/img/mdx-config.png b/.contributing/img/mdx-config.png deleted file mode 100644 index a4eab3b..0000000 Binary files a/.contributing/img/mdx-config.png and /dev/null differ diff --git a/.contributing/img/new-pull-request.png b/.contributing/img/new-pull-request.png deleted file mode 100755 index 7a6bc44..0000000 Binary files a/.contributing/img/new-pull-request.png and /dev/null differ diff --git a/.contributing/img/open-a-pr.png b/.contributing/img/open-a-pr.png deleted file mode 100755 index c67bb53..0000000 Binary files a/.contributing/img/open-a-pr.png and /dev/null differ diff --git a/.contributing/img/split-preview.png b/.contributing/img/split-preview.png deleted file mode 100755 index b65c633..0000000 Binary files a/.contributing/img/split-preview.png and /dev/null differ diff --git a/.contributing/img/vscode-auth-github.png b/.contributing/img/vscode-auth-github.png deleted file mode 100755 index 206626e..0000000 Binary files a/.contributing/img/vscode-auth-github.png and /dev/null differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index bfe3724..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,302 +0,0 @@ -# 贡献指南 - -## 文案风格 - -请先阅读[文案风格指南][style]，确保贡献的内容符合文案风格。 -其中的一些文案风格可能不符合很多人平时的行文习惯，比如： - -- 直角引号 -- 中文、英文、数字混合时的空格 -- 「你」和「您」 - -敬请特别留意。 - -[style]: https://blog.taptap.dev/pages/chinese-copywriting-guide - -## 文本格式 - -当前最新版本的中文文档在 `docs` 路径下，图片在 `static/img` 目录下，这是最常用到的两个目录。 - -完整的目录结构见 README 「目录结构」小节的说明。 - -文档使用 [markdown] 语法（在标准 Markdown 语法之外，还支持[一些扩展][docusaurus-markdown]）。 -文章开头的 front matter 通过 [YAML] 指定一些元数据，包括标题、侧边栏标签、URL 路径等。 - -[markdown]: https://www.markdown-cheatsheet.com -[docusaurus-markdown]: https://docusaurus.io/docs/markdown-features -[YAML]: https://quickref.me/yaml - -下面是一个例子： - -```markdown ---- -title: TapPlay 功能介绍 -sidebar_label: 功能介绍 -sidebar_position: 10 ---- - -## TapPlay 是什么？ - -TapPlay 是利用沙盒技术实现的可以让用户直接通过 TapTap 玩游戏的功能服务，旨在帮助开发者实现低成本、高效率的游戏开发，并提高游戏分发的转化率 - -（以下省略） -``` - -如果你了解 markdown 和 GitHub 协作的一般流程，那么现在就可以开始给 TDS 文档贡献内容了。 -期待你的第一个 [PR]！ - -[PR]: https://docs.github.com/en/get-started/quickstart/github-flow - -如果你不了解这些，也没关系，可以继续阅读下面的指南。 - -## GitHub 在线编辑 - -### 编辑 - -刚开始向文档贡献内容，一般从编辑现有文档开始。 -因此，我们先介绍编辑现有文档的流程。 - -在[TDS 文档的 GitHub 仓库页面][repo]点击右上角的「Fork」图标，fork 本仓库。 - -![fork](.contributing/img/github-fork.png) - -如果之前没有 fork 过，会 fork 一个新仓库；如果之前已经 fork 过，会提示你的 fork 的地址： - -![already forked](.contributing/img/forked.png) - -自己 fork 上的内容可能不是最新的，比如下面的截图中 GitHub 显示： - -> This branch is 3 commits behind taptap:master. - -意味着 fork 比主干落后 3 个提交。 - -![fetch upstream](.contributing/img/fetch-and-merge.png) - -点击 `Fetch upstream` 再点击 `Fetch and merge` 可同步主干上的内容。 -同步后，GitHub 会显示： - -> This branch is up to date with taptap:master. - -**在你 fork 的仓库页面**， 按下 `.` （英文句号），即可进入 GitHub 的编辑模式。 - -[repo]: https://github.com/taptap/tds-docs - -取决于操作系统和浏览器配置，这个快捷键也可能失效。 -如果快捷键不起效，可以把浏览器地址栏的 `github.com` 换成 `github.dev`，通过这种方式同样可以进入编辑模式。 - -这个 GitHub 编辑模式其实是一个功能精（shòu）简（xiàn）的 vscode 编辑器，所以它的用法可以参考 [vscode 的官方文档](https://code.visualstudio.com/docs)。 - -初次使用时会提示授权 vscode 访问 GitHub，点击 `Continue` 进入授权页面： - -![vscode auth github](.contributing/img/vscode-auth-github.png) - -授权页面会列出 GitHub for VSCode 需要的权限，点击 `Authorize github` 可以同意授权。 - -![authorize github](.contributing/img/authorize-github.png) - -最左侧由上往下的图标依次是菜单、文件、查找、源码控制等功能。 - -要编辑现有文档，首先需要找到对应的文件。 -最直观的方式是直接搜索。 -比如，《学习社区模块》中的「只有论坛主管理员可添加/删除版主权限」，我们想要把 `/` 改成顿号（`、`），这样更符合中文的行文习惯。 -那我们就可以直接点击最左侧的「查找」（放大镜图标），搜索这句话： - -![search text](.contributing/img/github-dev-search.png) - -点击即可跳转到相应文件的相应位置。 - -注意，初次搜索会自动启用索引，会把整个仓库的索引保存在本地浏览器中。 -由于 tds-docs 仓库较大，索引大小会超过默认的限制，需要点击 `Download Full Contents` 才能建立完整的索引，这样搜索时才能显示全部结果。 - -![download full content](.contributing/img/download-full-content.png) - -启用索引所以需要一些时间，请耐心等待。 -索引完成后即可搜索整个仓库。 - -还有一种方式是根据 URL 路径来查找文件。 -比如《学习社区模块》的 URL 是 `https://developer.taptap.cn/docs/community/features/`. -去掉网络协议（`https://`）、域名（`developer.taptap.cn`）后，URL 路径为 `/docs/community/features/`，那么对应的文件路径即为 `/docs/community/features.mdx`。 - -再比如，《开发者应对 DDoS 攻击问题的指引文档》的 URL 为 `https://developer.taptap.cn/docs/ddos/`，所以对应的文件路径为 `/docs/ddos.mdx`。 - -注意，有部分不在侧边栏显示的、隐藏入口的页面的 URL 和文件路径并不对应，这种情况请通过搜索查找。 -还有一些文件的命名没有遵循和 URL 路径保持一致的原则，这些属于历史遗留问题，会逐渐切换到标准的命名方式。 -如果受此问题困扰，可以在文档仓库提个 issue。 - -### 添加图片 - -如果需要添加图片，点击 `img` 左侧的箭头，展开文件夹后，直接把图片拖过去即可上传，可一次性拖拽多张图片。 - -图片的命名请使用小写英文字母、数字、连字符（`-`），**不要包含空格**（URL 中空格需要转义，如果文件名包含空格，后续 markdown 里引用图片的时候还要转义空格，比较麻烦，而且万一忘了转义图片就无法显示。图片文件名不用空格就可以避免这些烦心事）。 - -图片不要和已有的图片重名，除非你想更新现有的图片。 - -上传图片后，在 markdown 文件中通过以下 markdown 语法引用图片： - -```markdown -![图片的文字描述](/post-images/image-name.png) -``` - -注意，和其他 markdown 标记一样，这里的符号 ![] / 都是英文半角符号。 - -方括号内「图片的文字描述」，用于盲人、在浏览器中选择不加载图片（网速极慢或流量极贵）等场景，因为这样的场景比较罕见，所以也可以偷懒不填。 - -### 预览和提交 - -右上角有三个图标，最左侧的图标可以分栏显示预览，可以实时预览 markdown 的渲染效果。 - -![preview icon](.contributing/img/github-preview.png) - -`.mdx` 文件如果看不到预览按钮，需要额外配置： - -![configure file association for .mdx](.contributing/img/mdx-config.png) - -- 编辑器右下角点击「Plain Text」 -- 选择「Configure File Association for '.mdx'」，输入 Markdown - -预览仅供参考： - -- 许多 docusaurus 的 markdown 语法扩展预览 GitHub 在线编辑界面都不支持。 -- 个别 markdown 的渲染实现细节，docusaurus 和 GitHub 在线编辑界面存在差异。 -- docusaurs 定制了 CSS 样式。 - -![preview UI](.contributing/img/split-preview.png) - -最后在 Source Control 面板看一下变动情况，没问题的话就**点击 Changes 右侧的加号，让改动进入 Staged Changes**. - -![stage](.contributing/img/git-stage.png) - -最后在上面的 Message 文本框写一下 Commit Message，简单说明下做了什么改动。 -大多数情况下，用一句话简短描述改动内容即可。 -如有更多细节需要说明，可以空一行写详情。 - -``` -简短描述 - -可选的详情 -``` - -按 Ctrl/Command + Enter 即可提交。 - -![commit](.contributing/img/git-commit.png) - -提交后访问 https://github.com/YOUR-GITHUB-USERNAME/tds-docs/pulls （请替换 URL 中的用户名） - -![new pull request](.contributing/img/new-pull-request.png) - -在 Pull Requests 页面点击右上方绿色的 New pull request 按钮，会显示你所做的改动。 - -![compare changes](.contributing/img/compare-changes.png) - -大致看一下有没有问题，如果有问题的话，就关闭页面，重新回到 https://github.com/YOUR-GITHUB-USERNAME/tds-docs/ 按 `.` 进入编辑模式再修改。 - -没问题的话，点绿色的 Create pull request 按钮进入 PR 表单。 -PR 标题 GitHub 会自动填写，如果不满意，可以修改一下。 -右方 Reviewer 选择 fuchenshi 或 kylinbin 或其他相关的同事，然后再点绿色的 Create pull request 按钮提交。 - -![open a pull request](.contributing/img/open-a-pr.png) - -如果你还不是文档仓库的协作者，那么右方 Reviewer 处有可能无法选择 reviewer。 -如果你是内部贡献者，可以在 slack 上找 fuchenshi 添加为协作者； -如果你是外部贡献者，reviewer 可以留空，我们会定期 review 文档仓库的 PR. - -提交后 CI 会自动构建博客预览，请稍候。 -预览构建完成后，机器人 netlify bot 的回复中会出现「😎 Browse the preview: 」，点击后面的 URL 即可查看效果。 -不同于 GitHub 编辑模式自动的预览，这个是真正的预览，未来发布后，线上显示的效果和预览一模一样，包括各种格式和图片。 -有两条机器人回复，其中一个回复（URL 中的路径为 `tds-docs`）是 TDS 文档国内版的预览，另一个回复（URL 中的路径为 `tds-docs-intl`）是 TDS 文档国际版的预览。 - -![ci preview](.contributing/img/ci-preview.png) - -上图中，「All checks have passed」标明预览构建成功。 - -如果查看预览的过程中发现了问题，请重新回到 https://github.com/YOUR-GITHUB-USERNAME/tds-docs/ 按 `.` 进入编辑模式再修改。 -提交修改（Source Control 面板按 Ctrl/Command + Enter）后，PR 会自动更新，也会自动再次触发预览构建，请再次等待机器人 netlify bot 的回复中出现「😎 Browse the preview: 」,再次查看预览效果。 - -一切就绪后，等 reviewer 通过 PR 并合并，文档就正式发布到线上了。 -正式发布之后，再进入编辑模式修改就不会自动更新 PR 了（因为相关 PR 已经合并了），需要开新的 PR. - -如果预览构建失败，netlify 机器人的回复中会显示「❌ Deploy Preview for tds-docs-intl failed.」。 - -![ci failed](.contributing/img/ci-failed.png) - -请点击 Netlify 机器人回复的「🔍 Inspect the deploy log」后的链接查看构建日志。 -结合构建日志检查构建失败的原因。 -常见的错误包括修改内容不符合 docusaurus 的 markdown 扩展语法，以及指向的内部页面不存在。 -如认为所做修改没有问题，或者无法确定问题所在，可以在 PR 的评论中注明情况（比如怀疑可能是哪里有问题）。 -内部贡献者也可以在 slack 上询问。 - -### 新增文档 - -新增文档的步骤和编辑现有文档大致相同，只不过新增文档需要先新建相应的 `.mdx` 文件。 - -点击「文件」图标，在左栏点击 `docs` 旁的箭头可展开文件夹，之后在鼠标悬浮到 EXPLORER 右侧的 `...` 的下方，会出现四个图标，点击最左侧的「New File」文件即可新增文件。 - -默认配置下，文件名会成为 URL 的一部分，因此请使用小写英文字母、数字、连字符（`-`）。 -例如，在 `/docs/community/` 目录下新建 `features.mdx` 文件，那么发布后的 URL 会是 `https://developer.taptap.cn/docs/community/features`。 - -MDX 文件开头的 [YAML] front matter 指定元信息，注意 YAML 区域上下分别用三个短横 `---` 隔开，其中用到的短横、冒号、引号都是英文半角标点。 - -例如： - -```yaml ---- -title: TapPlay 功能介绍 -sidebar_label: 功能介绍 -sidebar_position: 10 ---- -``` - -常用的字段包括： - -- `title` 文档标题 -- `sidebar_label` 侧边栏显示的短标题。`title` 一般是语义完整的、较长的标题，而 `sidebar_label` 由于侧边栏显示空间有限，需要尽可能简短。如果不指定此字段，那么侧边栏会直接显示 `title` 的值。 -- `sidebar_position` 一个目录下有多个 MDX 文件时，通过 `sidebar_position` 来指定在侧边栏的顺序，数字越小越靠前。 - -如果是新模块，那么需要新增文件夹，Docusaurus 称之为 category。 -文件使用 YAML front matter 来指定元信息，文件夹则通过文件夹内的 `_category_.json` 文件来指定元信息。 - -例如，成就模块对应的文件夹为 `/docs/sdk/achievement`。 -相应地，`/docs/sdk/achievement/_category_.json` 的内容为： - -```json -{ - "label": "成就系统", - "collapsed": true, - "position": 7 -} -``` - -其中， - -- `label` 为侧边栏显示的标题。 -- `collapsed` 指定默认情况下是收起还是展开这一文件夹下的文档，一般都指定为 `true`。 -- `position` 指定文件夹在侧边栏的顺序，数字越小越靠前。 - -### 添加附件 - -添加附件的过程和添加图片类似，把文件拖放到 `/static/files` 目录下，然后在 Markdown 文件中通过 `pathname:///files/FILENAME.EXT` 链接到文件，例如： - -```markdown -推荐位的 icon 设计：尺寸为**200*200**，设计上建议简洁明了，可以用游戏内的 UI/ 角色头像，如没有合适素材，可[点击这里](pathname:///files/recommends-icons.zip)获取 TapTap 默认素材包。 -``` - -注意： - -- 路径需用 `pathname:///files/xxx`，而不是 `/files/xxx`，这是为了[绕开 Docusaurus 的一个 bug][85]。 -- 文件名会成为 URL 的一部分，因此请使用小写英文字母、数字、连字符（`-`）。 -- 拖放文件的路径为 `/static/files`，而链接文件时不带 `static`。 - -[85]: https://github.com/taptap/tds-docs/pull/85 - -## Tips - -Confluence wiki、Notion 等网页上的富文本内容，可以复制到 [Mark Text]（开源，推荐使用）、[Typora]（收费）、[StackEdit] （开源，可以在浏览器中直接使用，但对一些复杂格式的支持不如 Mark Text 和 Typora 全）可以快速转换为 markdown 代码。 -注意，部分格式转换时会丢失或错误，需要手工修正。 - -[Mark Text]: https://marktext.app -[StackEdit]: https://stackedit.io/app -[Typora]: https://typora.io - -命令行工具 [pandoc] 支持转换多种文件为 markdown，同样，部分格式转换时会丢失或错误，需要手工修正。 - -[pandoc]: https://pandoc.org/index.html diff --git a/README.md b/README.md index 925d20d..6166ccd 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ yarn start --locale zh-hans ## 贡献 -我们欢迎所有 TapTap 用户以及公司同事修改文档或提交 issue 为我们贡献或者修正错误，TapTap 衷心感谢您的贡献。 +我们欢迎所有 LeanCloud 用户以及公司同事修改文档或提交 issue 为我们贡献或者修正错误，LeanCloud 衷心感谢您的贡献。 **贡献方法及注意事项：** @@ -32,17 +32,15 @@ yarn start --locale zh-hans * 插入配图、图表和 PPT 等，可参考下文详细介绍。 * 预览文档。运行 `yarn` 命令安装所需要依赖，运行 `yarn start` 命令可以本地预览。 * 预览没问题后，提交修改并发起 Pull Request，并指定 Reviewer。 - * Reviewer 同意修改后，才可以合并 Pull Request。如果不知道该设置谁作为 Reviewer，可以指给技术支持同事（SXiaoXu、WatchMan-Wang、yuwenjian）。 - * Pull Request 合并后，会自动发布上线。文档每隔半小时自动检测是否有更新，如果有更新会自动部署。 + * Reviewer 同意修改后，才可以合并 Pull Request。 + * Pull Request 合并后，会自动发布上线。 * Pull Request 合并后，可删除当前分支。 - * 可参考 [Git Commit 日志风格指南](https://open.leancloud.cn/git-commit-message/) * 文档规范可参考 [中文文案风格指南](https://blog.taptap.dev/pages/chinese-copywriting-guide)。 ## 目录结构 ``` . -├── .ci 多品牌、多节点构建相关配置 ├── docs 中文文档 │ ├── ddos.mdx 隐藏文档 │ └── sdk 顶栏菜单项 @@ -58,14 +56,11 @@ yarn start --locale zh-hans │ └── navbar.json 顶栏菜单项翻译 ├── img 文档配图 ├── sidebars.js 菜单配置 -├── src -│ ├── docComponents 自定义组件（用于文档内容，如多编程语言） -│ ├── pages 文档以外的页面（目前只包含首页） -│ ├── styles 一些共享样式 -│ └── theme 自定义组件（用于文档内容以外的地方，如文档搜索） -├── versioned_docs 旧版文档内容 -├── versioned_sidebars 旧版文档菜单配置 -└── versions.json 历史版本配置 +└── src + ├── docComponents 自定义组件（用于文档内容，如多编程语言） + ├── pages 文档以外的页面（目前只包含首页） + ├── styles 一些共享样式 + └── theme 自定义组件（用于文档内容以外的地方，如文档搜索） ``` 其中编辑人员常用的目录有： @@ -257,61 +252,6 @@ import { OfficeDoc } from "/src/docComponents/doc"; ``` -#### SDK 版本号 - -SDK 版本号统一维护在 `/src/docComponents/sdkVersions.ts`。当 SDK 版本有更新时，只需在这里更新对应 SDK 的版本号，文档中所有引用这个版本号的地方就会跟着更新。 - -如果一篇文档需要引用 SDK 版本号，需要先在开头引入前面提到的这个文件： - -```js -import sdkVersions from "/src/docComponents/sdkVersions"; -``` - -如果版本号会出现在代码块中，还需要额外引入 `CodeBlock`： - -```js -import CodeBlock from "@theme/CodeBlock"; -``` - -根据版本号出现的位置不同，引用的方法也略有不同。如果版本号出现在一般段落中（非代码块），需要先将这部分段落用 JSX 语法改写，然后在版本号出现的地方插值： - -```diff -- - 华为（HMS) 'cn.leancloud:mixpush-hms:8.1.4' -- - 小米 'cn.leancloud:mixpush-xiaomi:8.1.4' -+ -``` - -如果版本号出现在代码块中，需要先将包裹代码块的 ` ``` ``` ` 用 ` {``} ` 替换，然后在版本号出现的地方插值。代码的语言可通过 `className` 传递给 `CodeBlock`： - -````diff -- ```groovy -- dependencies { -- //混合推送需要的包 -- implementation 'cn.leancloud:mixpush-android:8.1.4' -- //即时通信与推送需要的包 -- implementation 'cn.leancloud:realtime-android:8.1.4' -- implementation 'io.reactivex.rxjava2:rxandroid:2.1.0' -- -- implementation 'com.huawei.hms:push:4.0.2.300' -- } -- ``` -+ -+ {`dependencies { -+ //混合推送需要的包 -+ implementation 'cn.leancloud:mixpush-android:${sdkVersions.leancloud.java}' -+ //即时通信与推送需要的包 -+ implementation 'cn.leancloud:realtime-android:${sdkVersions.leancloud.java}' -+ implementation 'io.reactivex.rxjava2:rxandroid:2.1.0'\n -+ implementation 'com.huawei.hms:push:4.0.2.300' -+ }`} -+ -```` - -注意：如果代码中有空行，需要替换成 `\n` 放在前一行结尾，否则会报错。 - ### 文档中的链接、配图、文件 #### 链接 @@ -351,7 +291,7 @@ import CodeBlock from "@theme/CodeBlock"; ##### Tips -- DC 后台的截图：可以用 Chrome 插件 GoFullPage 截图，之后再使用 Figma 完成敏感信息遮盖、标注等，最后导出图片。 +- 可以用 Chrome 插件 GoFullPage 截图，之后再使用 Figma 完成敏感信息遮盖、标注等，最后导出图片。 - 一些需要绘制的图片：比如内嵌动态的很多图片，可以使用 UI/UX 同事的设计稿。 - IDE 或编辑器界面的截图：底色参考配图规范，尽量展示完整的界面。 @@ -398,25 +338,6 @@ import CodeBlock from "@theme/CodeBlock"; } ``` -## 多品牌、多节点 - -本项目为三个服务的文档提供了支持： - -- [TapTap 国内版](https://developer.taptap.cn/docs/) -- [TapTap 海外版](https://developer.taptap.io/docs/) -- [LeanCloud](https://docs.leancloud.cn/) - -这三个服务的文档内容各不相同，每个服务的文档都有一些它独有的页面。不同文档的配置也存在差异，比如 TapTap 国内版文档的默认语言是简体中文，而 TapTap 海外版文档的默认语言则是英文。同一篇文档中不同内容的显示与否也会由配置来决定。此外，LeanCloud 文档需要使用和 TapTap 文档不一样的配色风格。 - -Docusaurus 自身并没有提供「从一个项目构建出不同版本」的功能。为实现该功能，我们在 `.ci` 目录下放置了两个构建脚本（`build-hk.sh` 和 `build-leancloud.sh`），它们会分别在 TapTap 海外版文档和 LeanCloud 文档的构建阶段被执行，将当前项目中的文档文件（也就是 TapTap 国内版用到的文件）改造成目标版本的文档所需的文件。你可以通过浏览这两个构建脚本来了解不同版本的文档相对于 TapTap 国内版的文档存在哪些差异。 - -对于文档维护者来说，可以借助这两个脚本来控制不同版本之间的内容差异： - -- 加入 `docs` 和 `i18n` 的文档默认会出现在 TapTap 国内版和 TapTap 海外版的文档中，但不会出现在 LeanCloud 文档中。 -- 如果想在 TapTap 海外版文档中隐藏这篇文档，需要在 `build-hk.sh` 中使用 `rm` 命令移除相关文件。 -- 如果想在 LeanCloud 文档中显示这篇文档，需要在 `build-leancloud.sh` 中使用 `cp` 命令将相关文件复制到临时目录中。 -- `.ci` 目录中提供了名为 `hk` 和 `leancloud` 的两个目录，分别用于存放仅适用于 TapTap 海外版的文档和仅适用于 LeanCloud 的文档。如需添加仅适用于某个版本的内容，请将文件放入对应目录，并在构建脚本中借助 `cp` 命令将文件复制到合适的位置。 - ## 文档发布注意事项 - 不支持 html 文件脚本，直接复制 markdown 过来的文件可能无法初始化