Markdown(マークダウン)記法ガイド
この操作手順書は作成中です。内容は順次更新します。
SiteAskでは、チャットの開始メッセージや「よくある質問」の固定回答・案内メッセージなど、入力欄の下に**「Markdownを利用できます」**と表示されている箇所でMarkdown(マークダウン)記法を使用できます。
Markdown記法を使うと、簡単な記号を組み合わせるだけで文字を太字にしたり、箇条書きやリンクを作成したりでき、チャット画面の回答や社内ドキュメントを誰にとっても読みやすく整えることができます。
1. よく使う基本の書き方一覧
チャット画面の案内文や一般的なドキュメントでよく使う基本の記法です。
| やりたいこと | Markdownの書き方(入力例) | 実際の画面での表示イメージ |
|---|---|---|
| 文字を太字にする | **重要なポイント**です | 重要なポイント です |
| 打ち消し線を引く | ~~ 旧料金 ~~ 新料金 | |
| 箇条書きにする | - 項目A - 項目B | ・項目A ・項目B |
| 番号付きリストにする | 1. 手順1 2. 手順2 | 1. 手順1 2. 手順2 |
| 文字にリンクを貼る | [料金プランはこちら](https://example.com) | 料金プランはこちら |
| 見出しをつける | ### 営業時間について | (「営業時間について」が見出し3になります) |
| 引用・補足枠にする | > ※土日祝は休業です | (左側に縦線が入った補足枠になります) |
| 区切り線を入れる | --- | (横線が引かれます) |
2. SiteAskで使える独自の一覧
SiteAskで使える独自のMarkdown記法一覧です。
| やりたいこと | Markdownの書き方(入力例) | 実際の画面での表示イメージ |
|---|---|---|
| 固定回答や案内文の中に質問ボタンを表示する | :next[SiteAskの使い方は?] | –案内文– こんにちは! SiteAskです。 SiteAskのサービス~~以下省略 ––––––– SiteAskの使い方は? |
3. 各記法の詳しい書き方とコツ
3-1. 太字(強調)・打ち消し線
目立たせたい単語や注意事項を、半角のアスタリスク2つ(**)で囲みます。
※閉じるアスタリスクの後ろには半角スペースを1つ入れてください。前後が全角文字や記号とくっついていると、太字にならない場合があります。
【入力例】
3-2. 箇条書き・番号付きリスト(階層化)
複数の項目を並べて見やすくしたいときに使います。
※記号の後ろには必ず半角スペースを1つ入れてください。また、行頭に半角スペースを2つ(または4つ)入れてから - を書くと、一段下げた補足リストを作れます。
【入力例(箇条書きと階層化)】
【入力例(番号付きリスト)】
3-3. リンク(URLの設置)
長いURLをそのまま貼るのではなく、 [表示する文字](URL) の形でスッキリとしたリンクにできます。 [] や () はすべて半角で入力します。
【入力例】
3-4. 見出し(文字を大きくする)
行の先頭に半角のシャープ(#)と半角スペースを入れると見出しになります。# の数が増えるほど見出しレベルが小さくなります( # が見出し1、 ## が見出し2、 ### が見出し3)。
【入力例】
【チャット画面で見やすくするコツ】
チャット画面は横幅がコンパクトなため、 # 1つ(大見出し)を使うと文字が大きすぎることがあります。チャット内の見出しには ##(シャープ2つ) や ###(シャープ3つ) 程度を使うとバランスよく表示されます。
3-5. 引用(補足メモ・注意事項の枠)
行の先頭に半角の不等号(>)と半角スペースを入れると、補足情報や注意事項を枠で囲んで目立たせることができます。
【入力例】
3-6. 表(テーブル)の作成
項目と内容を並べて比較したいときは、半角の縦棒(|)とハイフン(-)を使って表を作ることができます。2行目の | :--- | :--- | が「ここから表のデータが始まる」という合図になります。
【入力例】
3-7. 改行と段落分け(余白の作り方)
Markdownでは、Enterキーを1回押しただけでは改行が反映されないことがあります。
文章を区切りたいときは、次のいずれかの方法を使います。
- 1行空けて段落を分ける(おすすめ): Enterキーを2回押して、間に空行を1行入れます。上下にほどよい余白ができ、チャット画面で一番読みやすくなります。
- 同じ段落のまま改行する: 行の最後に半角スペースを2つ入れてからEnterキーを押します。
【入力例】
4. Markdownの作成例
固定回答や案内メッセージを作成する際は、以下のように作成することを推奨します。
※ガードレール設定のプロンプト設定は、プロンプト設定のドキュメントに記載がある項目を使用して内容を作成してください。
5. 記述するときの注意点
- 記号はすべて「半角」で入力する
*(アスタリスク)、#(シャープ)、-(ハイフン)、[]()(カッコ)などが全角になっていると、装飾が反映されず記号がそのまま表示されてしまいます。 - 記号の後ろには必ず「半角スペース」を入れる
見出し(### タイトル)や箇条書き(- 項目)、引用(> メモ)は、記号の直後に半角スペースがないと正しく認識されません(全角スペースも不可)。 - 記号をそのまま文字として表示したいとき(エスケープ)
たとえば「#1(ナンバー1)」や「-10%」と書きたいのに、勝手に見出しや箇条書きに変換されてしまう場合は、記号の直前に半角のバックスラッシュ(\)を入れて\#1のように書くと、ただの文字としてそのまま表示されます。 - チャット内での表(テーブル)の使いすぎに注意する
チャットウィンドウは横幅が狭いため、列数が多い表を作ると文字が縦に折り返されて読みづらくなることがあります。チャット内では**「見出し+箇条書き」**で整理することを推奨します。 - 質問ボタン表示(
:next[])との組み合わせ
SiteAsk独自の機能である:next[質問文]を文章の末尾に記述すると、Markdownで整えた回答文の下に「次の質問ボタン」を表示させることができます。