用 Seafile 公开资料库功能高效发布文档

在Seafile 7.0中,用户可以将一个资料库作为公共资料库来对外发布。如果你有对外的手册、指南等文档需要发布,就可以使用这一功能。 比如我们 Seafile 的服务器手册就是发布为一个公开的资料库。


用 Seafile 公开资料库功能高效发布文档_第1张图片

公开资料库中的 Markdown 格式的文件会直接在公开资料库界面中展现。公开资料库中也可以包含任意格式的文件,这些文件点击后会在单独的外链页面中打开,访问者可以在线查看或者下载这些文件。

现在很多开源软件作者都会将文档作为代码托管在 github 上,然后将 Markdown 文件编译成 html 再对外发布。通过直接将文档的原始 Markdown 文件保存在 Seafile 中,即可以所见即所得的方式来编辑维护文档,同时对外发布,大大简化了流程。后续我们会专门写一篇文章来介绍如何将现有的文档从 Github, Gitbook 等平台迁移到 Seafile。

发布一个资料库为公开资料库

如下图所示,在Seafile网页端左侧工具栏选择“已发布的资料库”,再点击正上方的“发布资料库”按钮,选择并提交需要发布的资料库即可。已发布的资料库将显示在下方列表中,任何人都可以通过该资料库的url来访问其中的文件。

用 Seafile 公开资料库功能高效发布文档_第2张图片

公开资料库中的导航

你可以用两种方式为公开资料库提供导航:

  • 直接显示目录树
  • 使用 index.md 文件

直接显示目录树

对简单的文档,你可以不用自定义导航,资料库左边栏会直接显示出目录树。访问者可以在目录树中快速访问某个文件。


用 Seafile 公开资料库功能高效发布文档_第3张图片

使用 index.md 文件

当我们需要发布手册这种文档时,导航条目应该是按照方便大家阅读的顺序来编排,而目录树只能以资料库固有的目录顺序来提供导航,也不支持调整导航条目的顺序。为了解决这个问题,在Seafile专业版7.0.4或者社区版7.0.3版本之后,我们可以在资料库中手动创建 index.md 文件,并通过插入列表来自定义导航条目的名称和顺序。

如下图所示,创建 index.md 文件之后,你可以插入列表并为每个列表项添加一个文档的链接,方便在导航中跳转。列表项的名称可以修改,每个列表项都会转化为导航中一个同名的条目,条目的顺序和自定义列表项的顺序是一致的。


用 Seafile 公开资料库功能高效发布文档_第4张图片

如下图所示,在index.md文件中插入自定义列表之后,当用户访问公开资料库时,左边的导航栏显示的不再是目录树,而是一个和列表每一项的名称、顺序完全一致的导航。点击左侧导航中任意一个条目,界面右侧都会立刻呈现出对应的文档内容。


用 Seafile 公开资料库功能高效发布文档_第5张图片

Seafile 7.0 版本现在已经发布到了 Seafile 的官网(https://www.seafile.com/download/),感兴趣的用户可以去下载使用,欢迎大家反馈意见!

你可能感兴趣的:(用 Seafile 公开资料库功能高效发布文档)