MirrorZ文档兼容支持
考虑与 https://help.mirrorz.org/ 文档兼容,
转自@yaoge123转自MirrorZ:
随着 transpiler 的出现(可以直接生成 markdown 或自己的 markdown dialect),这个事情变得清晰了,现在有两种模式
1.(样例 TUNA)自己维护一份 lug/mirrorz-help;通用的东西放在 mirrorz-org/mirrorz-help,然后特定于各站的的东西放在自己 fork 的 mirrorz-help 里面(比如 njulug/mirrorz-help),然后从 lug/mirrorz-help trannspile 出来一些 markdown 可以直接扔给现有的前端渲染要改动通用的镜像帮助的时候,就往 mirrorz-org/mirrorz-help 发 PR,然后自己的 fork 会 merge upstream change;特定于自己的改动就直接写在自己的 mirrorz-help 里面然后各个社区可以有人来做 mirrorz-org/mirrorz-help 的维护,这样合并东西起来比较方便,难度也不大。这样各站的维护难度是往上游 PR 和自己 rebase/merge 和自己 transpile,好处是能获得 lug/mirrorz-help 这样的表意能力
1.5. 不维护 lug/mirrorz-help,在现有前端里面直接放特有的 markdown,这样的维护难度是往上游 PR 和每几次上游更新要 transpile 一次
2.(样例 ISCAS)直接指向 help.mirrors.cernet,这样就几乎没有维护负担
3.(样例 xtom.help)自己部署一份
4.(样例 neusoft)全站镜像
Edited by Tongzhou Ji