Discourse 文档类别

我可以在这里使用外部链接吗?并且使用 _blank 在新标签页中打开?

您可以从可选的类别简短描述开始。

## 测试外部
* Google: https://google.com

## 第一个部分
* 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
1 个赞

任何不受支持的安装通常都会收到一个指向不受支持的安装的链接。作为免责声明,因为任何问题都可能部分相关。

插件、主题和主题组件通常会有一个关于版本兼容性的文件。

见下文

打开此文件将提供重要的版本兼容性说明。其他文件可能在其描述中。例如,Category Moderators 增强插件的免责声明是仅支持稳定分支。

Pavilion 建议了推荐的 discourse 更新频率,以确保他们有时间更新其附加组件。

2 个赞

这适用于子类别吗?我有一个包含 6 个核心类别的网站,但想要每个类别的文档以及讨论。不太确定如何最好地实现这一点。

是的,您可以在#documentation中看到它。主类别基本上是子类别的目录。

3 个赞

我刚看到这个,有几个问题想请教一下:我们如何将其安装到我们托管的云网站上?您认为旧版文档还能保留多久?

1 个赞

我们还没有完全移除旧插件的时间表,但它已不再积极开发。一旦我们对此做出一些决定,我们会发布公告告知大家!

由于此插件仍处于#实验阶段,因此无法在我们的托管服务上使用,但我们目前正在内部讨论并查看是否可以提供此插件。一旦得出结论,我们会在此处回复。

5 个赞

我只是想为其他可能觉得困惑的人补充一下,就像我之前一样,这个插件到底有什么作用。

考虑到所有的设置、索引主题等等,可能会让人不知所措,再加上还要理解它可以做什么,如何使用它等等。至少,我有点困惑,直到我找到一种理解它的方法(如果我遗漏了什么,请随时分享)。

所以基本上,我的看法是:按照你想要的方式创建你的类别,然后这个插件会移除默认的侧边栏(包含类别、标签等部分),并用一个包含部分和链接的列表来替换它,这些链接指向主题、类别、外部链接等。对我来说,这样看更容易。它更侧重于在访问特定类别时自定义侧边栏。有点像:当访问类别 A 时,用索引主题提供的自定义侧边栏替换默认侧边栏。很简单。

5 个赞

9 个帖子被拆分到一个新主题:Discourse Docs 插件 – 文档页面上的主题未更新

我想知道如何让 Docs 上的侧边栏索引在移动端更明显,因为用户在未点击汉堡菜单图标前看不到主题。

在桌面端表现得很棒;不幸的是,大多数用户使用的是智能手机。

1 个赞

选项不多,或者说根本没有选项。手机空间太小了。

这也是我考虑完全放弃文档的原因之一。我的用户中大约有 95% 使用手机,他们很少使用侧边栏,甚至从不使用。因此,精心策划文档菜单非常耗时,而且我认为时间和收益的比例不平衡 :smirking_face:

1 个赞

我认为将汉堡包图标移到左侧(就像在桌面上一样)应该能稍微改善用户体验。

文档功能非常强大,我不想禁用它,但我们的用户几乎不使用它,因为索引是隐藏的(!)

2 个赞

这个 Theme component 也许会让你感兴趣

好的,我已经阅读了整个讨论,有几个问题。我明白此页面的结构是由此页面创建的,但之后您还需要为每个子类别创建一个索引页吗?此页面的索引,或者其他包含大量文章的索引,一定非常庞大……

实现 xwiki 风格的页面布局,用于 Discourse 站点文档的一部分,难度有多大?UI 足够简单,您在创建页面时勾选“此页面是文档”的复选框。现在它只问您父级是什么。没有父级?它是一个顶级主题。您设置了一个父级,该页面就会显示在该主题/类别下。这完全消除了手动维护索引页的需要。它们看起来需要很多额外的工作,而且不应该有这种需求。并且在创建页面时很容易忽略添加内容。

如果您访问 https://checkin.technospider.com 并展开侧边栏中的一些项目,您可以看到嵌套是如何在真实示例中工作的。整个侧边栏是通过将页面嵌套在其他页面下(父子关系)动态生成的。该网站只有大约 150 页,但如果我必须创建索引来完成所有这些工作,我将花费两倍的时间。

这就引出了文档侧边栏布局的 UI/UX 问题。一旦您点击了主页面以外的任何地方,您就会失去最初的类别列表。您应该有一个方法可以回到页面上的某个位置。
您应该在 8 个主要区域上都有展开三角形,这样无论您是点击主页面上的框,还是侧边栏中的名称,它都会直接下拉,而您不会失去直接点击另一个主要区域的能力。
您在每个最终文章上都有一个面包屑导航,但即使是 8 个类别也缺少这个。点击页面顶部的子类别中的“删除过滤器”会带我回来,但这非常不直观。并且通过调整过滤器,您可以做一些奇怪的事情,例如,如果您点击“无子类别”,漂亮的绿色横幅就会消失。

3 个赞

是的,那是关于站点管理主题的,索引页面在这里。index 是一个标签,可以显示所有索引页面)

同意,整理所有页面链接并将它们很好地分类并加上标签一定花费了大量精力。但结果非常棒,而且非常实用!

2 个赞

它看起来确实不错,但正如我所说,在导航方面存在一些可用性问题。
如果可以消除工作量,这对每个人来说都是一个胜利。

我并不是在批评这项工作,它看起来非常好,而且由于我根本不会编码,所以我无法开始欣赏其中付出了多少努力,也无法估量我的建议会增加多少工作量。

它适用于最低限度的文档,但缺少我之前链接的维基中使用的许多标记。除非是我错过了。我对 Discourse 仍然相当陌生。

例如,我找不到创建信息/警告/错误框的方法。

在 Meta 上,使用了块引用和表情符号。
也许这个 Theme component,它提供了替代样式,可以满足您的需求:

3 个赞

谢谢,一旦不再需要手动索引,这看起来将很有帮助。

已将 7 个帖子拆分为新主题:在 Discourse Doc Categories 插件中恢复侧边栏搜索

一则帖子被合并到现有主题:添加侧边栏支持“Discourse 图标”及更多

:loudspeaker: 自托管用户更新说明

对于使用此插件的自托管用户,我们最近的更新需要手动重建索引。这需要运行以下 rake 任务:

bundle exec rake doc_categories:build_sidebar

# 如果运行上述任务因 NoDatabaseError 而失败,
# 请在典型的自托管设置中运行以下命令
sudo -E -u discourse bundle exec rake doc_categories:build_sidebar

如果您无法运行此 rake 任务,您可以转到每个文档类别的设置,删除类别索引,保存,重新添加,然后保存。这将重建它们并刷新类别缓存。


为什么要这样做?

以前,当需要填充侧边栏时,我们会即时解析每个索引主题并进行缓存。此次更新将现有的索引从主题支持迁移到数据库支持。这样做为我们的团队提供了更多选项,以便在考虑改进索引组织的用户体验方面有更多选择。

9 个赞