【Backlog記法チートシート】wiki作成にもPRにも役立つ…！？

はじめに

こんにちは、エンジニア2年目の嶋田です。
まずは、この記事を開いていただきありがとうございます！

今回はBacklogチートシートを作成しました。

というのも、markdown記法とは違い、backlog記法となるものが存在するみたいでして。
wikiを書くとき、課題作成の内容を書くときに少し戸惑ってしまったので…
(markdownもプロジェクトによって選択可能です！)
備忘録としてまとめます！

Backlog記法チートシート

機能	記法	結果
見出し	* 見出し1 ** 見出し2 *** 見出し3
箇条書き	- 箇条書き1 - 箇条書き2 -- 箇条書き2-1 --- 箇条書き2-1-1
番号付きリスト	+ 項目1 + 項目2

強調

• '''太字テキスト'''
• ''斜体テキスト''
• %%打ち消しテキスト%%
• &color(red) { 赤文字テキスト }
• &color(#ffffff, #8abe00) { 背景色付きテキスト }

リンク

• [[リンクテキスト>URL]]

コードブロック

• {code:言語}コード{code}
• {code}コード{code} (言語指定なし)

表

• |見出し1|見出し2|
• |:------|------:|
• | 左寄せ | 右寄せ |

チェックボックス

• - [ ] 未チェック
• - [x] チェック済み

引用

• > 引用文

水平線

• ---

色付きテキスト

• {color:red}赤いテキスト{color}

注釈

• ((注釈テキスト))

Markdown記法とBacklog記法の主な違い

1. 見出し:

   • Markdown: # (ハッシュ)記号を使います（例: # 見出し1, ## 見出し2）。
   • Backlog: * (アスタリスク)記号を使います（例: * 見出し1, ** 見出し2）。

2. リスト:

   • Markdown: 箇条書きに- や * を使い、番号付きリストに数字を使用します。
   • Backlog: 箇条書きに- を使い、番号付きリストには+ を使用します。

3. 強調:

   • Markdown: **テキスト** または __テキスト__ で強調（太字）。
   • Backlog: '''テキスト''' で強調（太字）。

4. リンク:

   • Markdown: [表示テキスト](URL)。
   • Backlog: [[表示テキスト>URL]]。

5. 画像:

   • Markdown: ![代替テキスト](画像URL)。
   • Backlog: [[画像(画像URL)]]。

6. コードブロック:

   • Markdown: バッククォート（`）3つで囲みます。
   • Backlog: {code} タグを使用します。

最後に

少しでもお役に立てたら嬉しいです！

参考文献