Markdown記法とBacklog版の記法について

8255 ワード
Backlog Markdown Markdown テキストリンク

はじめに

先日、Redmine上でwikiに大量の業務エビデンスを残しておりました。
今まで見よう見真似でなんとなく書いてきたものの、、、なんだか穴あきだらけの知識。
Qiitaへの投稿や、近いうちにBacklogを利用することもあり
復習も兼ねて、Markdown記法について整理しようと思いました。

見出し


# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

結果

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

Backlog見出し

2種類の見出しの形式をサポートしています。
下行に「=」や「-」を付けた行は見出しとして見なされます。
「=」や「-」の数はいくつでも構いません。
また、「#」から始まる行も見出しとして見なされます。
Backlog

斜体文字/太文字/打消し

前後に 半角スペース か改行文字が必要。

アンダースコア×1 or アスタリスク×1で囲むと *italic* になる
アンダースコア×2 or アスタリスク×2で囲むと **太字** になる
チルダ×2で囲むと文字が ~~打消し~~ される

イタリック体（斜体) : emタグ
アンダースコア×1 or アスタリスク×1で囲むと italic になる
強調：strongタグ
アンダースコア×2 or アスタリスク×2で囲むと 太字 になる
打消し
チルダ×2で囲むと文字が 打消し される

リスト

箇条書き(Disc型)

  • アスタリスク、プラス、ハイフンのいずれかを使用する
  • リストの上下に空行を入れる
  • 記号の後にはスペースが必要
* リスト1
    * ネスト リスト1_1
        * ネスト リスト1_1_1
        * ネスト リスト1_1_2
    * ネスト リスト1_2
* リスト2
* リスト3
  • リスト1
    • ネスト リスト1_1
      • ネスト リスト1_1_1
      • ネスト リスト1_1_2
    • ネスト リスト1_2
  • リスト2
  • リスト3

番号付きリスト(Desimal型)

  1. 文頭に「半角数字＋半角ドットマーク」を入れる
  2. 後からの挿入/移動を考慮して、1. 1. 1. という風に同じ数字にしておくと◎
  3. リストの上下に空行を入れる
  4. 記号の後にはスペースが必要
1. 番号付きリスト1
    1. 番号付きリスト1_1
    1. 番号付きリスト1_2
1. 番号付きリスト2
1. 番号付きリスト3
  1. 番号付きリスト1
    1. 番号付きリスト1_1
    2. 番号付きリスト1_2
  2. 番号付きリスト2
  3. 番号付きリスト3

チェックボックス

  • 箇条書きの記述の後ろに[]を入れる。(カッコ内、スペース半角スペース必要)
  • チェックが入った状態は[x]を入力する。
  • 前後スペースが必要
* [ ] task-A
* [ ] task-B
* [x] task-C
  • task-A
  • task-B
  • task-C

引用

文頭に「>」をおくことで引用になる

>引用A
>引用B
>引用C

引用A
引用B
引用C

罫線

以下、すべて罫線となります。記号は3つ以上記入する必要あり。

* * *

***

*****

- - -

---------------------------------------

_ _ _

リンク

* [リンクテキスト](URL"タイトル")
* [リンクテキスト](URL)
* [リンクテキスト][名前]
* [名前]:URL

画像

![代替テキスト](画像のURL)
![ドーナツ](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/506754/9556cd7a-0ba9-c9d0-0302-18a04b2048ea.jpeg)

結果

コードブロック

  • 行頭にスペース×4(tab) を挿入する or 「```」で該当部分を囲む
  • 文章内の一部にコードブロックを適用する場合は、該当部分を「`」で囲む。

テーブル

  1. 列(半数)×行(半数)を入力すると、入力補完される
  2. 「-」を「:」で囲むことで中央寄せ/右寄せ/左寄せになります。
  3. 太文字や斜体可能
|ヘッダー1|ヘッダー2|ヘッダー3|
|:--|--:|:--:|
|align left|align right|align center|
|a|**b**|*c*|
ヘッダー1 ヘッダー2 ヘッダー3
align left align right align center
a b c

Backlog(一般的なMarkdown記法との違い)

段落と改行

Markdownでは行頭から書き始めればそれが段落となり、空行を挟むことで別の段落になります。
Markdownでは行頭から書き始めればそれが段落となり、空行を挟むことで別の段落になります。

HTMLタグ

通常、Markdownでは文中にHTMLタグを書くことができますが、Backlogではセキュリティ上の懸念により文中のHTMLタグを無視します。

拡張

参考