在定制 Discourse 时,理想情况下,您应该使用 CSS、JavaScript 插件 API 或 插件插槽。如果这些方法都不适用于您的用例,请随时向 Discourse 核心提交 PR 或在此处 Meta 上开启一个 Dev 主题。我们随时乐意讨论添加新的插槽/API 以简化定制。
如果您已尝试所有其他选项,则可能需要使用模板覆盖。此技术允许您从主题/插件中覆盖 Ember 组件或路由的整个模板。
不推荐使用此方法定制 Discourse。 Discourse 核心的日常更改最终会与您的模板覆盖冲突,可能在渲染论坛时导致灾难性错误。
如果您决定采用此方法,请确保您拥有充足的自动化测试和 QA 流程来检测回归。如果您分发的主题/插件包含模板覆盖,请确保论坛管理员了解您的主题/插件带来的稳定性风险。
2023 年 10 月更新:对于新功能,Discourse 越来越多地转向使用使用 Ember 的
.gjs文件格式编写的组件。这些组件的模板是内联定义的,无法被主题/插件覆盖。今后,所有模板定制都应使用 插件插槽 进行。
我明白这在不久的将来会失效,但还是给我看文档
覆盖组件模板
要覆盖 Ember 组件模板(即 Discourse 核心中 components/* 下的任何内容),您应该在主题/插件中创建一个同名的 .hbs 文件。例如,要覆盖 Discourse 核心中 badge-button 组件的模板,您将在主题/插件中的以下位置创建一个模板文件:
{theme}/javascripts/discourse/templates/components/badge-button.hbs
{plugin}/assets/javascripts/discourse/templates/components/badge-button.hbs
覆盖必须始终嵌套在 /templates 目录中,即使核心组件具有“并置”模板。
覆盖路由模板
覆盖路由模板(即 templates/* 下的所有非组件模板)的工作方式与组件相同。在主题/插件中创建一个同名的模板。例如,要覆盖核心中的 discovery.hbs,您将创建一个类似以下的文件:
{theme}/javascripts/discourse/templates/discovery.hbs
{plugin}/assets/javascripts/discourse/templates/discovery.hbs
覆盖“原始”模板 (.hbr)
Discourse 的“原始”模板系统很快将被常规 Ember 组件取代。但在此期间,覆盖原始模板的工作方式与 Ember 模板相同。例如,要覆盖核心中的 topic-list-item.hbr,您可以创建一个类似以下的文件:
{theme}/javascripts/discourse/templates/list/topic-list-item.hbr
{plugin}/assets/javascripts/discourse/templates/list/topic-list-item.hbr
多个主题/插件之间的交互
如果多个已安装的主题/插件覆盖了同一个模板,则“获胜者”是此列表中排名最低的那个:
- 主题覆盖(最高的主题“id”获胜)
- 插件覆盖(最新的字母顺序插件名称获胜)
- 核心
此优先级也意味着您可以从主题覆盖插件模板。技术上您也可以从其他主题覆盖主题模板,从其他插件覆盖插件模板,但由于依赖于插件名称和主题 ID,行为可能会令人惊讶。
这是如何工作的?
Discourse 在 DiscourseTemplateMap 类中组装和优先处理模板。对于并置的组件模板,该信息在 应用初始化期间 用于替换核心模板关联。对于所有其他模板,该映射由 运行时解析器 用于获取正确的模板。
此文档已进行版本控制 - 在 github 上建议更改。