Skip to content

Commit

Permalink
chore: 更新 readme
Browse files Browse the repository at this point in the history
  • Loading branch information
huangliling committed Sep 6, 2024
1 parent b19ac23 commit 4b1249a
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,21 +436,12 @@ import CodeBlock from "@theme/CodeBlock";

## 多品牌、多节点

本项目为三个服务的文档提供了支持
本项目为两个服务的文档提供了支持

- [TapTap 国内版](https://developer.taptap.cn/docs/)
- [TapTap 海外版](https://developer.taptap.io/docs/)

这三个服务的文档内容各不相同,每个服务的文档都有一些它独有的页面。不同文档的配置也存在差异,比如 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` 命令将文件复制到合适的位置。
这两个服务的文档内容各不相同,每个服务的文档都有一些它独有的页面。不同文档的配置也存在差异,比如 TapTap 国内版文档的默认语言是简体中文,而 TapTap 海外版文档的默认语言则是英文。同一篇文档中不同内容的显示与否也会由配置来决定。

## 文档发布注意事项

Expand Down

0 comments on commit 4b1249a

Please sign in to comment.