本插件即将停用,推荐使用实验性的 Doc Categories 插件。在新插件不再被视为实验性之前,我们仍将继续支持 Docs。
| 摘要 | Discourse Docs 提供了查找和筛选知识库主题的功能 | |
| 仓库链接 | https://github.com/discourse/discourse-docs | |
| 安装指南 | 如何在 Discourse 中安装插件 |
功能
Discourse Docs 插件是一个强大的工具,它将你的 Discourse 论坛转变为由社区驱动的知识库。它提供了一个专门的 Docs 部分,用户可以在其中创建、更新和管理文档。该插件包含一个 Docs 按钮,方便用户访问该部分。这是利用社区集体智慧并为重要信息提供集中资源的好方法。
本质上,Docs 允许在定义的一组类别和/或标签中更轻松地展示知识库类型的主题。
通过标签筛选列表,通过搜索栏进行搜索,并点击主题查看第一篇文章——所有这些操作都不必离开知识探索器的上下文。
需要查找 Discourse 其他位置的知识库主题吗?使用新的搜索辅助命令:in:kb。
配置
-
通过开启
docs enabled设置来启用插件。 -
将类别和标签添加到
docs categories和docs tags设置中。 -
在导航菜单中找到 Docs 链接。
- 轻松获取知识,获益匪浅!
设置
| 名称 | 描述 |
|---|---|
| docs enabled | 启用 Docs 插件 |
| docs categories | 包含在 docs 中的类别 slugs 列表 |
| show tags by group | 使用标签组组织标签。创建组以分类相关标签。 |
| docs tag groups | 用于按组显示标签的标签组 |
| docs tags | 包含在 docs 中的标签列表 |
| docs add solved filter | 添加已解决主题的筛选器——需要安装并启用 Discourse Solved |
| docs add to top menu | 在顶部菜单中添加链接以导航至 Docs 视图 |
| docs add search menu tip | 在搜索菜单的随机提示中添加 “in:docs” 提示 |
有用的搭配
重命名 /docs 路径
如果你有权访问服务器,可以通过在 app.yml 中添加 DISCOURSE_DOCS_PATH: 环境变量来更改 /docs 链接的路径:
要使更改生效,你可以执行 ./launcher rebuild app,或者由于这是环境变量,你可以执行 ./launcher destroy app && ./launcher start app 以将停机时间降至最低。此处有更多相关信息 - Set Environmental Variables
你可能还需要更改站点显示文本以保持一致。你可以从 /admin/customize/site_texts 页面搜索所有包含 ‘docs’ 的实例,但主要的包括:
- js.docs.title
- js.sidebar.docs_link_text
由我们托管? 重命名
/docs路径仅在我们的企业计划中可用。如需了解更多,请联系我们。
开发历史
Docs 插件是 Knowledge Explorer 主题组件 的延续。
由我们托管? 该插件在我们所有的托管计划中均可用。 https://www.discourse.org/plugins/docs.html






