Discourse 文档

:warning: 此插件正在被弃用,取而代之的是实验性的 Doc Categories 插件。在新插件不再被视为实验性版本之前,我们仍将继续支持 Docs。

:discourse2: 摘要 Discourse Docs 提供了查找和筛选知识库主题的功能
:hammer_and_wrench: 仓库链接 https://github.com/discourse/discourse-docs
:open_book: 安装指南 如何在 Discourse 中安装插件

功能

Discourse Docs 插件是一个强大的工具,可将您的 Discourse 论坛转变为由社区驱动的知识库。它提供了一个专用的 Docs 部分,用户可以在其中创建、更新和整理文档。该插件包含一个 Docs 按钮,可轻松访问该部分。这是利用社区集体知识并为重要信息提供集中资源的好方法。

本质上,Docs 允许在定义的一组分类和/或标签中更容易地呈现知识库风格的主题。

通过标签筛选列表,通过搜索栏进行搜索,并点击主题查看第一篇文章——所有操作均可在知识库浏览器的上下文中完成,无需离开。

需要在 Discourse 的其他地方查找知识库主题吗?请使用新的搜索辅助功能:in:kb

配置

  1. 通过启用 docs enabled 设置来启用插件。

  2. 将分类和标签添加到 docs categoriesdocs tags 设置中。

  3. 在导航菜单中找到 Docs 链接。

  1. 享受更便捷的知识访问体验!

设置

名称 描述
docs enabled 启用 Docs 插件
docs categories 要包含在 Docs 中的分类 slug 列表
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

:discourse2: 由我们托管? 重命名 /docs 路径仅在我的企业计划中可用。如果您想了解更多,请联系我们。

开发历史

Docs 插件是 Knowledge Explorer Theme Component 的延续。


:discourse2: 由我们托管? 此插件适用于我们的所有托管计划。https://www.discourse.org/plugins/docs.html

95 个赞
Discourse Doc Categories
Using Posts as a Wiki?
Using Discourse as a internal Knowledge Base / Intranet
Is anyone working on a Discourse Wiki?
Documentation Library
Community glossary?
The Docs button on meta.discourse
Memberful opinions?
Subcategories and tag groups layout
[Paid] Parent/Child Tagging System + Docs Plugin Group Tagging
Discourse Category Lockdown
Filtering by multiple tags
Docs page in Discourse
Mirrored topic: same topic in two categories
Discourse Docs + Pavilion Layouts Plugin
FAQs, less thread-y more article-y
Topic List Previews (TLP)
Email list server?
Recommnded plugins for supporting a tech community run by a big enterprise?
Is it possible to display the thumbnails in Docs?
Customize docs plugin text link
Install discourse doc plugin from Git is failed
What is this component?
Advice on a support forum
Knowledge Base
Grow my community
Published topic with a link to itself in the forum?
Topic List Thumbnails don't play well with Docs
How-to use Discourse for managing a collaborative newsletter?
Is it possible to restrict certain “docs” to appear based on the user’s groups?
Pinning a post to the top of the topic
Knowledge Base
Discourse has slowly been solving a fatigue I didn't realize I had
Documentation in a Discussion forum
Discourse docs search error, 500 error
Discourse docs search error, 500 error
Discourse Docs Plugin – Topics Not Updating in Docs Page
Forum not working after update – what’s missing?
Knowledge Base
Making my discourse site look a certain way
Time tracking using Discourse?
Back button behavior on docs
Workspace Views
New documentation plugin in development
Is anyone here using their Discourse instance as their entire website?
Question Answer Plugin
How to make the recommanded topics collection
New homes for official and community documentation
Is it possible to show tags in place of subcategories?
Disable auto-scroll for certain topics?
Implementing KCS
How can I compare arbitrary revisions of a post?
How to create a page like the official Discourse docs?
Option to use "Docs view" when accessing Docs category from anywhere in Discourse
DiscoTOC - automatic table of contents
When a thread is too important to lose
About this Community and the Docs
Ability to Create Private Templates
Tips into building a community aside a variety of already existing tools
Sidebar for Subcategories
Published page not visible?
Nest subcategories under their parent categories in the sidebar
File/Document Repository?
Creating user guides for your community
Allow plugins (like docs) to add top-level links in sidebar (rather than hide them in More...)