OtterTrade 文档站

墨七2024年11月12日大约 3 分钟约 990 字...

OtterTrade 文档站

起源

文档站的构成

文档站的源码存放于 https://github.com/otter-trade/doc-otter-trade ，是个开源仓库，主体由 vuepress-hope 搭建。

其编译结果存放于 https://github.com/otter-trade/otter-trade.github.io 仓库，因此可以直接利用 Github Pages 的特性。

然后通过 Webhooks 机制同时部署在两台不同的服务器之上。

所以文档站的基本工作流就是:

向墨七申请 doc-otter-trade 和 otter-trade.github.io 这两个仓库的权限；
利用 git clone 命令下载文档站源码；
在编写完对应文档之后，编译打包并推送至 otter-trade.github.io 仓库完成发布。

# 克隆 文档站 源码到本地
git clone git@github.com:otter-trade/doc-otter-trade.git
# 用 Vscode 打开
code ./doc-otter-trade

然后你就获得了如下界面

除此之外你可能还需要安装如下插件

然后你就可以愉快的开始编写文档了！

命令介绍

在项目目录的 ./package.json 文件中我提前编写了如下指令

{
  // ....
  "scripts": {
    "dev": "vuepress-vite dev src",
    "build": "vuepress-vite build src",
    "clean-dev": "vuepress-vite dev src --clean-cache",
    "update-package": "pnpm dlx vp-update",
    "sync": "./_shell/GitSync.sh",
    "deploy": "./_shell/Deploy.sh"
  }
  // ....
}

使用方法如下:

pnpm run dev
# 在本地启动该项目

pnpm run build
# 编译该项目

pnpm run clean-dev
# 清除所有的编译缓存，并启动项目，如果一些配置或者编写的文章没有生效则可以使用该指令

pnpm run update-package
# 更新项目依赖

pnpm run sync
# 拉取 Github 上的最新改动，并保存和提交当前改动 同时 推送至 Github ，需要仓库权限

pnpm run  deploy
# 编译本项目并同时推送至  otter-trade.github.io 仓库， 然后将会自动完成项目的部署与发布, 需要仓库权限