テキスト整形のルール (Markdown 記法)
目次
見出し
2種類の見出しの形式をサポートしています。
- 下行に「=」や「-」を付けた行は見出しとして見なされます。「=」や「-」の数はいくつでも構いません。
- 「#」から始まる行も見出しとして見なされます。
| 入力文字の例 | 結果 |
|
見出し1 |
|
引用
「>」から始まる行は引用分として見なされます。
| 入力文字の例 | 結果 |
|
> 引用した内容です。 |
|
リスト
「*」「+」「-」から始まる行は箇条書きとして見なされます。
数字と「ピリオド」から始まる行は番号付きの箇条書きとして見なされます。
記号の後にはスペースが必要です。
また、各々の階層の中に段落を設けたい場合は4文字のスペースを挿入してください。
| 入力文字の例 | 結果 |
|
* 箇条書き1 |
|
チェックリスト
課題詳細の入力画面にて、リスト記法の先頭を「 [ ] 」または「 [x] 」で開始すると、チェックボックス付きのリストに変換されます。
また、変換されたチェックボックスで、チェックを入れたり外したりすると、課題が更新されます。
チェックリスト記法は課題詳細のみで使用できます。
| 入力文字の例 | 結果 |
|
* [ ] Item-A |
|
コードブロック
コードブロックを使用したい場合、行頭にスペースを4つ挿入することでコードブロックとして見なされます。
また、「```」で該当部分を囲むことでもコードブロックとして見なされます。
文中の該当部分のみにコードブロックのスタイルを使用したい場合、「`」で括ると、インラインコードとして見なされます。
| 入力文字の例 | 結果 |
|
```
package helloworld; public class Hello { public static void main(String[] args) { System.out.println("Hello World"); } } ``` ``` package helloworld; public class Hello { public static void main(String[] args) { System.out.println("Hello World"); } } ``` `インラインコード` |
|
罫線
3つ以上の「-」や「*」、「_」だけで構成されている行は罫線となります。
| 入力文字の例 | 結果 |
|
* * *
******** - - - --------------------------------------- _ _ _ |
|
リンク
リンク文字列を「[]」囲み、その直後に「()」で囲んだURLを記述することでリンクと見なされます。
また、Backlogでは前後をスペースで区切られたURLやメールアドレスは自動的にリンクと見なされます。
| 入力文字の例 | 結果 |
| このバグについては、このページ [Backlog](https://backlog.com/ja/) が参考になります。 このバグについては、このページ https://backlog.com/ja/ が参考になります。 support-ja@backlog.com までメールを送ってください。 |
このバグについては、このページ Backlog が参考になります。 |
斜体文字、太字、打ち消し
「*」や「_」によって囲まれた文字列は斜体になります。
「**」や「__」によって囲まれた文字列は太字になります。
「~~」で囲まれた文字は打ち消しになります。
| 入力文字の例 | 結果 |
|
これは *斜体文字* です。
これは _斜体文字_ です。 これは **太字** です。 これは __太字__ です。 これは ~~打ち消し~~です。 |
これは 斜体文字 です。 |
画像
「!」に続き Alt 文字列を「[]」囲み、その直後に「()」で囲んだURLを記述することで画像と見なされます。
| 入力文字の例 | 結果 |
|
|
|
テーブル
Backlog は PHP Markdown Extra ライクなテーブルをサポートしています。
「|」は列の区切りに使われます。
空白を入れずに「|」入れることでその左のセルを結合することができます。
（横にセルを連結することはできますが、縦に連結することはできません。）
複数の「-」はヘッダー部とボディ部の区切りに使われます。また、その両端を「:」で囲むことでその列を中央寄せに、右端に「:」を付けることで右寄せになります。
最後に「[]」で囲んだ文字列はテーブルのタイトルになります。
| 入力文字の例 | 結果 |
|
| | 結合 || |
|
定義リスト
Backlog は PHP Markdown Extra ライクな定義リストをサポートしています。
用語を表す1行に続き、「:」で始まる用語の定義を付与することができます。
また、用語ごとに複数の定義を持つことができます。
| 入力文字の例 | 結果 |
| カレー : 複数の香辛料を使って野菜や肉などのさまざまな食材を味付けした料理。 国際的に人気のある料理のひとつ。 : フランス北部パ＝ド＝カレー県の都市。 シチュー : 野菜や肉、魚介類を出汁やソースで煮込んだ煮込み料理 |
|
特殊な文字のエスケープ
「\(¥)」を特殊な文字の前に書くことで、そのまま文字を出力することが可能です。
| 入力文字の例 | 結果 |
|
\*Not Striked\*
\\\\Home\hoge\hoge2 |
*Not Striked* |
課題リンク、Wikiページリンク
課題キーを直接書くか、あるいは課題キーを２重かっこで囲むことで、他の課題へのリンクを作成できます。
| 入力文字の例 | 結果 |
|
これはどうやら[[BLG-104]]と同じ現象のようです。
BLG-87 も合わせて参照してください。 まずは [[Home]] をみてください。 |
Subversionリビジョンへのリンク
「#rev(リビジョン番号)」と記述するとSubversionのリビジョン詳細へのリンクを挿入できます。
| 入力文字の例 | 結果 |
|
#rev(11)
|
Gitリビジョンへのリンク
「#rev(リポジトリ:リビジョン)」と記述するとGitのリビジョン詳細へのリンクを挿入できます。
| 入力文字の例 | 結果 |
|
#rev(app:abcdefg)
|
Wiki添付ファイルへのリンク
Wikiページに添付されたファイルへのリンクを挿入できます。
通常はツールバーを利用して挿入しますので、記法を意識する必要はありません。
| 入力文字の例 | 結果 |
|
#attach(sample.zip:11)
|
Wiki添付ファイル画像の表示
Wikiページに添付された画像ファイルを挿入できます。
通常はツールバーを利用して挿入しますので、記法を意識する必要はありません。
| 入力文字の例 | 結果 |
|
#image(11)
|
|
目次
「[toc]」と記述すると見出しに基づいて目次を作成します。
| 入力文字の例 | 結果 |
|
[toc]
# ヘッダ1 ## ヘッダ1-1 ## ヘッダ1-2 # ヘッダ2 ## ヘッダ2-1 ### ヘッダ2-1-1 |
|
一般的なMarkdown記法との違い
段落と改行
Markdownでは行頭から書き始めればそれが段落となり、空行を挟むことで別の段落になります。一般的なMarkdownでは段落中の改行は削除されますが、Backlogの場合は無視されずに改行されます。
HTMLタグ
通常、Markdownでは文中にHTMLタグを書くことができますが、Backlogではセキュリティ上の懸念により文中のHTMLタグを無視します。
拡張
Backlogは基本的なMarkdownの記法に加えて以下のような記法をサポートしています。