本参考指南详细介绍了 Discourse 帖子中所有可用的格式设置选项,包括 Markdown、BBCode 和 HTML。它指明了哪些受支持,并提供了可查看示例的资源。
所需用户级别:所有用户
了解帖子中受支持的格式设置
虽然纯文本对于大多数回复来说已经足够,但 Discourse 允许用户通过使用 Markdown、BBCode 和 HTML 来增强其帖子的格式。本指南解释了支持哪些类型的格式设置以及如何有效地使用它们。
您还可以通过向 @discobot 发送私信(在本站或任何 Discourse 站点上)来在一个交互式教程中练习一些基础知识。
摘要
本指南涵盖:
- 支持的 Markdown 语法
- 支持的 BBCode 标签
- 支持的安全 HTML 标签和属性
最佳实践
- 主要使用 Markdown,因为它简单易读。
- 仅在必要时混合使用 Markdown 和 BBCode,并保持使用一致。
- 限制使用 HTML 仅限于简单、安全的标签,以避免格式化问题并确保帖子安全。
支持的 Markdown
Discourse 使用 markdown-it 来实现其 Markdown。
一些常用的 Markdown 功能包括:
-
粗体:
**text** -
斜体:
*text* -
链接:
[title](https://example.com) -
行内代码:`code` -
高亮:
<mark></mark> -
代码块:
``` code block ```
在较长的帖子(如本帖)中,使用标题来添加结构也很有帮助:
# Heading 1
## Heading 2
### Heading 3
注意:上传图片时,引用图片的 Markdown 语法会自动生成。

有关 Markdown 功能的完整列表,请参阅交互式指南。
支持的 BBCode
Discourse 支持常见 BBCode 标签的一个子集,其中一些是自动生成的,以支持特殊格式,例如当您在回复中引用帖子时:
[quote=“user”]quoted text[/quote]
[quote="user"]quoted text[/quote]
您也可以使用 BBCode 将文本标记为剧透或详情
spoiled text
[spoiler]spoiled text[/spoiler]
[details=“click to expand”]hidden text[/details]
[details="click to expand"]hidden text[/details]
支持与 Markdown 兼容的简单格式的 BBCode 标签:
[b]strong[/b][i]emphasis[/i][u]underlined[/u][s]strikethrough[/s][ul][li]option one[/li][/ul][img]http://example.com/image.png[/img][url]http://example.com[/url][code]code[/code]
有关支持的 BBCode 标签和示例的完整列表,请查看Discourse BBCode 测试。
支持的 HTML
Discourse 支持一个安全的 HTML 子集。虽然您可以将 HTML 与 Markdown 混合使用,但只允许特定的 HTML 标签和属性,以确保安全性和一致的样式。
一些允许的 HTML 标签包括:
<a href="https://example.com">link</a><strong>bold text</strong><em>italic text</em><ul><li>list item</li></ul><img src="https://example.com/image.png" alt="description">
有关允许的 HTML 标签和属性的详细列表,请参阅Discourse 的允许列表。
注意: 不支持内联样式,例如 <span>colored text</span>。有关自定义样式,请参阅使用您自己的样式自定义帖子内容。
常见问题和解决方案
- BBCode 或 HTML 标签不起作用: 确保您使用的标签是受支持子集的一部分。
- 内联样式被移除: 出于安全原因,Discourse 不支持内联样式。如有必要,请使用自定义样式或插件。
- 从其他编辑器粘贴时格式发生变化: 某些富文本格式可能无法正确渲染。使用 Markdown 来保持格式一致性。
常见问题解答 (FAQs)
问:我可以在 Discourse 中使用表格吗?
答:是的,您可以使用 Markdown 创建表格。有关更多信息,请参阅此表格指南。
问:为什么我的内联样式不起作用?
答:出于安全原因,Discourse 不支持 HTML 中的内联样式。请考虑使用自定义 BBCode 或 Discourse 自定义样式指南。
问:我可以添加自定义 BBCode 标签吗?
答:是的,您可以添加自定义 BBCode 标签。有关更多信息,请参阅Discourse BBCode 插件。
附加资源
- 交互式 Markdown 指南:https://markdown-it.github.io/
- 使用您自己的样式自定义帖子内容:Customize posts' contents with your own styles
- Discourse BBCode 插件:Discourse BBCode