GitHub Actions 处理markdown文档的经验分享

很多网站的文档产品考虑安全性方面的问题,在博客、文档上都开始禁止用户评论了。

借助GitHub的Issue完成社区的讨论;

使用GitHub Actions 完成文档体系的建设。

分享一下最近我进行的经验,先说一下遇到的问题:

  1. 本人加入了某个全球知名的存储开源组织;
  2. 但是中文文档一直很糟糕;
  3. 我计划汉化他们;

软件的处理思路分享:

  1. 拿到官方的包;
  2. 建立好页面模板;
  3. 使用Python处理文档生成为Html;

Delopy的逻辑:

  1. GitHub Actions 在 push状态生成的时候监听;
  2. 升级python pip;
  3. 将生成的文档pip install -r requirements.txt 加载;
  4. make docs,将文档生成为html;
  5. 使用rsync 将文档同步至远程的服务器;

自动文档更新,完成。

其他参考:

你也可以使用jenkins或者docker 完成相关的工作。

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注