github中的wiki是干嘛的_如何从 Github/Gitbook 迁移 Wiki 到 Seafile

最新推荐文章于 2024-04-20 14:31:00 发布

璇钰

最新推荐文章于 2024-04-20 14:31:00 发布

阅读量1.7k

点赞数

文章标签： github中的wiki是干嘛的

本文链接：https://blog.csdn.net/weixin_34711401/article/details/113580789

版权

本文对比Seafile和Gitbook在Markdown文档编辑、管理和发布的便利性，Seafile作为一站式解决方案，简化流程并提高发布效率，特别适合国内用户。迁移现有Wiki到Seafile的步骤也详细说明。

摘要由CSDN通过智能技术生成

用 Seafile 提升发布文档效率

Markdown 因其易用性已成为软件文档的首选格式，有的研发团队会产出大量 Markdown 文档，并需要将这些文档公开发布出去，方便大家查阅资料。Gitbook 是目前最流行的 Markdown 文档发布工具，很多人会使用它来发布 Markdown 文档，但 Gitbook 在Markdown 文档的编辑、管理上都需要借助第三方工具，导致文档发布的流程较为繁琐。而 Seafile 7.0 可以作为一站式的 Markdown 文档发布平台，文档的编辑、管理和发布都可以在 Seafile 系统内部完成，能够带来 Markdown 文档发布效率的显著提升。

关于如何使用 Seafile 来对外发布文档，我们已经在上一篇文章中介绍过了。

下面我们对 Seafile 和 Gitbook 进行一下对比，并简单介绍 Seafile 的文档发布流程。

Seafile 和 Gitbook 对比

Gitbook 是一个基于 Markdown 的文档制作和发布工具，但 Gitbook 本身并不具备 Markdown 文档编辑功能，所以你需要在本地安装一个离线的 Markdown 编辑器(比如 Typora)。同时由于国内很难顺畅地访问 Gitbook 网站，所以文档源码只能保存在 Github 上，你不得不再下载一个 Git 工具来将文档源码 push 到 Github 上。

安装了 Git+Typora+Gitbook 之后，通常的发布流程是你需要先在电脑本地编辑 Markdown 文档，再 push 到 Github 项目上托管你的文档源码，最后通过 Gitbook 自动同步 Github 的项目完成文档的编译、发布，这种方式流程繁琐而且效率不高。

总结下来 Gitbook 有以下几个不方便的点：

只能用于发布 Markdown 文档，编辑、管理 Markdown 文档要依赖第三方工具
发布流程繁琐，效率不高

针对以上痛点，Seafile 7.0 则可以看作是一个集 Markdown 文档的编辑、管理、发布于一体的 Markdown 文档发布平台。Seafile 本身就提供了所见即所得的 Markdown 编辑器，让用户可以直接在浏览器中对 Markdown 文档进行编辑，编辑完成后文档可以直接保存在 Seafile 系统中。当你想对外公开发布软件文档时，你可以创建一个资料库，在资料库中编辑多个 Markdown 文档，然后将资料库以维基的形式公开发布出去。相比 Gitbook 的发布流程，省去了从 github 下载、push 、再发布到第三方文档平台的麻烦。

如果你还想同时保留原有的工作流程(发布到 Gitbook 平台)，你也可以使用 Seafile 的同步客户端将维基对应的资料库同步到你的本地电脑上，然后用 git 将改动从电脑 push 到 github。这样相当于把 Seafile 作为一个优秀的Markdown编辑平台来使用，其好处是你可以在编辑时立即看到效果，不需要 push 到 github 上看。由于 Seafile 将维基页面保存为纯文本的 Markdown 文件，所以可以无缝与 github、git 这些工具兼容。

总结下来 Seafile 相比 Gitbook 有以下几个优势：