このリファレンスガイドでは、markdown、BBCode、HTMLを含む、Discourseの投稿で利用可能なすべての書式設定オプションについて詳しく説明します。サポートされている内容と、例を確認できるリソースを示します。
必須ユーザーレベル: 全ユーザー
投稿でサポートされている書式設定の理解
ほとんどの返信ではプレーンテキストで十分ですが、Discourseではユーザーがmarkdown、BBCode、HTMLを使用して投稿の書式設定を強化できます。このガイドでは、サポートされている書式設定の種類と、それらを効果的に使用する方法について説明します。
また、@discobot にプライベートメッセージを送信するか、Discourseサイトのいずれかで送信することで、インタラクティブなチュートリアルで基本的な操作を練習することもできます。
要約
このガイドでは、以下の内容を扱います。
- サポートされているmarkdown構文
- サポートされているBBCodeタグ
- サポートされている安全なHTMLタグと属性
ベストプラクティス
- 主にmarkdownのシンプルさと可読性を利用します。
- markdownとBBCodeは必要な場合にのみ混在させ、使用法を一貫させます。
- HTMLの使用は、書式設定の問題を回避し、投稿の安全性を確保するために、シンプルで安全なタグに限定します。
サポートされているmarkdown
Discourseは、markdownの実装に markdown-it を使用しています。
一般的に使用される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”]引用されたテキスト[/quote]
[quote="user"]quoted text[/quote]
BBCodeを使用して、テキストをスポイラーとして、または詳細として非表示にすることもできます。
ネタバレテキスト
[spoiler]spoiled text[/spoiler]
[details=“クリックして展開”]隠されたテキスト[/details]
[details="click to expand"]hidden text[/details]
markdownによってサポートされている、またはサポートされている単純な書式設定のためのBBCodeタグ:
[b]強調[/b][i]強調表示[/i][u]下線付き[/u][s]取り消し線[/s][ul][li]オプション1[/li][/ul][img]http://example.com/image.png[/img][url]http://example.com[/url][code]コード[/code]
サポートされているBBCodeタグと例の完全なリストについては、Discourse BBCodeテスト を確認してください。
サポートされているHTML
Discourseは、安全なHTMLのサブセットをサポートしています。HTMLとmarkdownを混在させることはできますが、セキュリティと一貫したスタイリングを保証するために、特定のHTMLタグと属性のみが許可されます。
許可されているHTMLタグには以下のようなものがあります。
<a href="https://example.com">リンク</a><strong>太字のテキスト</strong><em>斜体のテキスト</em><ul><li>リスト項目</li></ul><img src="https://example.com/image.png" alt="description">
許可されているHTMLタグと属性の詳細なリストについては、Discourseの許可リスト を参照してください。
注: <span style="color:red">色付きのテキスト</span> のようなインラインスタイルはサポートされていません。カスタムスタイルについては、投稿コンテンツのカスタマイズ を参照してください。
一般的な問題と解決策
- BBCodeまたはHTMLタグが機能しない: 使用しているタグがサポートされているサブセットに含まれていることを確認してください。
- インラインスタイルが削除される: Discourseはセキュリティ上の理由からインラインスタイルをサポートしていません。必要に応じて、カスタムスタイルまたはプラグインを使用してください。
- 他のエディタから貼り付けたときに書式設定が変更される: リッチテキスト形式によっては正しくレンダリングされない場合があります。一貫した書式設定にはmarkdownを使用してください。
FAQ
Q: Discourseでテーブルを使用できますか？
A: はい、markdownを使用してテーブルを作成できます。詳細については、テーブルに関するこのガイド を参照してください。
Q: インラインスタイルが機能しないのはなぜですか？
A: Discourseはセキュリティ上の理由からHTMLのインラインスタイルをサポートしていません。カスタムBBCodeまたはDiscourseのカスタムスタイリングガイドの使用を検討してください。
Q: カスタムBBCodeタグを追加できますか？
A: はい、カスタムBBCodeタグを追加できます。詳細については、Discourse BBCodeプラグイン を参照してください。
追加リソース
- インタラクティブなmarkdownガイド: https://markdown-it.github.io/
- 投稿コンテンツのカスタマイズ: Customize posts' contents with your own styles
- Discourse BBCodeプラグイン: Discourse BBCode
