||||
-|-|
| 摘要 | Discourse Doc Categories 允许将特定类别预留用于文档，从而为其启用额外功能。
| 仓库链接 | https://github.com/discourse/discourse-doc-categories
| 安装指南 | 如何在 Discourse 中安装插件
请注意，此插件正处于积极开发中，尚未完全完成。
功能
Discourse Doc Categories 插件允许您在现有的 Discourse 论坛中托管结构化文档。它通过预留特定类别用于文档，并提供功能以便更容易查找特定文档主题来实现这一目标。
您可以在 Documentation 类别中看到它的实际效果。
当将某个类别标记为文档位置时，该类别将启用以下功能：
- 指定一个主题作为该类别中所有文档主题的索引
- 一个新的侧边栏，用于在类别内的不同主题之间导航，包括内置的过滤和搜索功能
- 新的报告，帮助您维护索引主题的一致性
此外，该插件还处理从 已停用的 Docs 插件 迁移的站点的重定向。来自该插件的文档链接将重定向到其现有的主题 URL，并且有一个设置用于将您之前的文档主页重定向到您的主文档类别。
配置
配置设置位于 example.discourse.com/admin/site_settings/category/doc_categories。在这里您将找到以下设置：
doc categories enabled：选择以启用 Doc Categories 插件。doc categories docs legacy enabled：如果您已从弃用的 Docs 插件迁移，请选择此项。doc categories homepage：启用上一个设置后，弃用的 Docs 插件的着陆页将重定向到此 URL。
要指定哪些类别将用于文档，请为其分配一个索引主题。为此，通过点击类别页面上的 
图标打开类别的设置。从那里，点击“Settings”链接并向下滚动到“Documentation mode”部分。使用“Index topic”字段指定将用作该类别索引的主题。
索引主题
文档类别的索引主题有两个用途：
- 它们是类别中包含的所有主题的中心列表
- 与此插件一起包含的侧边栏由索引主题内容填充
格式化索引主题
索引主题可以包含您喜欢的任何内容。为了使侧边栏正常工作，它们需要包含一个项目符号列表（或多个项目符号列表）的文档主题。这些可以简单地是列表中的主题 URL，在这种情况下，侧边栏将显示每个文档主题的完整标题。
如果标题超过几个字，在侧边栏中显示完整标题可能不太实用，因此要为特定主题设置较短的标题，请在 URL 前加上缩短的标题后跟冒号 (:)。冒号之前的所有文本将在侧边栏中显示，并链接到主题 URL。
您可以将索引主题划分为多个部分，并在每个部分上方使用带有标题（任何级别）的多个列表——它们将在侧边栏中按这些部分显示。
以下是一个索引主题的示例，供您参考：
您可以从可选的类别简要描述开始。
## 第一部分
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* 短标题: https://discourse.example.com/t/topic-with-a-long-title/56
* 另一个标题: https://discourse.example.com/t/another-topic-with-a-long-title/78
## 第二部分
* 主题标题: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
该示例将输出如下所示的文档侧边栏：
查看 Documentation > Site Management 索引主题，以了解文档类别索引的实际效果： https://meta.discourse.org/t/site-management-index/308032
维护索引主题
虽然索引主题不会随着类别中内容的添加、删除或编辑而自动更新，但该插件包含新的报告，突出显示索引主题中不一致的地方。
-
未索引的主题：
example.discourse.com/admin/reports/doc_categories_missing_topics
此报告显示文档类别中未添加到索引的任何主题。 -
多余的项目：
example.discourse.com/admin/reports/doc_categories_extraneous_items
此报告显示索引中包含的看起来不应该存在的项目。报告将指示主题被包含在报告中的原因——例如，如果它已被删除或它位于与其包含的索引主题不同的类别中。
附加信息
在搜索词中添加字符串 in:docs 将搜索所有标记为文档的类别（即已分配索引主题的类别）。
索引中的最大项目数由 Max oneboxes per post 站点设置设置，默认值为 50。如果您需要超过 50 个索引项目，请增加该设置中的数字。
）
我正在探索将我的文档迁移到 
