このリファレンスガイドでは、Discourseの投稿で利用可能なすべての書式設定オプション（マークダウン、BBCode、HTMLを含む）について詳しく説明します。サポートされている内容と、例を確認できるリソースを示します。
必要なユーザーレベル：すべてのユーザー
投稿でサポートされている書式設定の理解
ほとんどの返信ではプレーンテキストで十分ですが、Discourseではユーザーがマークダウン、BBCode、HTMLを使用して投稿の書式設定を強化できます。このガイドでは、サポートされている書式設定の種類と、それらを効果的に使用する方法について説明します。
また、インタラクティブなチュートリアルで基本的な操作を試すには、@discobotにプライベートメッセージを送信するか、任意のDiscourseサイトで送信してください。
要約
このガイドでは、以下について説明します。
- サポートされているマークダウン構文
- サポートされているBBCodeタグ
- サポートされている安全なHTMLタグと属性
ベストプラクティス
- シンプルさと可読性のために、主にマークダウンを使用します。
- マークダウンとBBCodeは必要な場合にのみ混在させ、使用法を一貫させます。
- HTMLの使用は、書式設定の問題を回避し、投稿のセキュリティを確保するために、シンプルで安全なタグに限定します。
サポートされているマークダウン
Discourseは、マークダウン実装にmarkdown-itを使用しています。
一般的に使用されるマークダウン機能の例：
-
太字:
**text** -
斜体:
*text* -
リンク:
[title](https://example.com) -
インラインコード:`code` -
ハイライト:
<mark></mark> -
引用ブロック:
> quoted text -
コードブロック:
``` code block ```
（これのような）長い投稿では、見出しを使用して構造を追加することも役立ちます。
# Heading 1
## Heading 2
### Heading 3
注：画像がアップロードされると、画像を参照するためのマークダウン構文が自動的に生成されます。
マークダウン機能の全リストについては、インタラクティブガイドを参照してください。
サポートされているBBCode
Discourseは、一般的なBBCodeタグのサブセットをサポートしており、その一部は、例えば返信で投稿を引用する際などに、特別な書式設定をサポートするために自動的に生成されます。
[quote="user"]quoted text[/quote]
また、BBCodeを使用してテキストをスポイラーや詳細として非表示にすることもできます。
spoiled text
[spoiler]spoiled text[/spoiler]
[details="click to expand"]hidden text[/details]
マークダウンでサポートされているか、またはサポートされている単純な書式設定のための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をマークダウンと混在させることはできますが、セキュリティと一貫したスタイリングを保証するために、特定の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 style="color:red">colored text</span>のようなインラインスタイルはサポートされていません。カスタムスタイルについては、投稿内容のカスタマイズを参照してください。
一般的な問題と解決策
- BBCodeまたはHTMLタグが機能しない: 使用しているタグがサポートされているサブセットの一部であることを確認してください。
- インラインスタイルが削除される: Discourseはセキュリティ上の理由からインラインスタイルをサポートしていません。必要に応じて、カスタムスタイルまたはプラグインを使用してください。
- 他のエディタからの貼り付けで書式設定が変わる: リッチテキスト形式によっては正しくレンダリングされない場合があります。一貫したテキスト書式設定にはマークダウンを使用してください。
よくある質問 (FAQ)
Q: Discourseでテーブルを使用できますか？
A: はい、マークダウンを使用してテーブルを作成できます。詳細については、テーブルに関するこのガイドを参照してください。
Q: インラインスタイルが機能しないのはなぜですか？
A: Discourseはセキュリティ上の理由からHTMLのインラインスタイルをサポートしていません。代わりに、カスタムBBCodeまたはDiscourseのカスタムスタイリングガイドの使用を検討してください。
Q: カスタムBBCodeタグを追加できますか？
A: はい、カスタムBBCodeタグを追加できます。詳細については、Discourse BBCodeプラグインを参照してください。
追加リソース
- インタラクティブなマークダウンガイド: https://markdown-it.github.io/
- 投稿内容のカスタマイズ: Customize posts' contents with your own styles
- Discourse BBCodeプラグイン: Discourse BBCode
