記事投稿シリーズについて
QiitaでGitHub Flavored Markdown (以下GFM) に準拠したMarkdownパーサーがベータ版として公開されました！
Qiitaアカウントによる説明記事にも書いてあるのですが、今までと記法が変わっている箇所があるので注意が必要です。
せっかく書いた記事の表示が崩れてしまうのは困るので、可能な限り防ぎたいと考えています！
そこで、記事を書く時に注意すべき記法などについて、Qiita運営から5日間に分けて10記事のシリーズで投稿することになりました！
少しでも皆様が執筆する際の助けになればと思います。
詳しくはQiitaアカウントによる説明記事に、投稿シリーズの説明や、他の記事一覧が載っていますのでぜひ他の記事も読んでみてください！
この記事ではGFMの記法のうち、「リスト」について説明します。
基本の書き方
リストには複数の型があり状況に合わせて使い分けることができます。
Disc型
- foo
- bar
- baz
見え方は以下のようになります。
- foo
- bar
- baz
- 以外にも *, + が使えます。
Decimal型
1. foo
1. bar
1. baz
見え方は以下のようになります。
- foo
- bar
- baz
数字から始まれば問題ないため、後から項目を追加・移動できるように全て1から始めることもできます。
Checkbox型
- [ ] タスク1
- [x] タスク2
見え方は以下のようになります。
- タスク1
- タスク2
基本的な書き方は変わっていませんが、書き方によってはリストが崩れてしまう箇所もあるので、変更点を見ていきます。
変更点
リストのアイテム内に任意のブロックを含めることができるようになる
リストのアイテム内での改行が反映されることや、引用などのブロックも反映することができます。
- foo
bar
> baz
- foo
barbaz
リストの上に改行がない場合でもリストとして解釈されるようになる
この行の下に改行がなくてもOK
1. foo
2. bar
この下に改行がなくてもOK
- foo
- bar
ネストする時には段落と同じ数のスペースが必要
以下の場合はfooと同じ位置になるよう2つのスペースがないとネストされません。
- foo
- bar
- foo
- bar
同様に、以下の場合はfooと同じ位置になるよう3つのスペースがないとネストされません。
1. foo
1. bar
- foo
- bar
tabキーで4つのスペースを空けれるので活用しましょう。
区切り文字を変更すると新しいリストが開始されます
このような書き方はしないと思いますが、区切り文字は統一しておきましょう。
- foo
+ bar
1. baz
- ban
- foo
- bar
- baz
- ban
Disc型の中でDecimal型の記述をするとDecimal型も展開される
展開されないように.の後ろのスペースを無くすか、Decimal型のみで利用しましょう。
- 1. foo
- 2. bar
-
- foo
-
- bar
最後に
今回はQiitaのMarkdownパーサー変更に伴う、リストについての注意点を説明しました。
他の記法についてもまた別の記事でまとめていますので、合わせて読んでみてください！
詳しくはQiitaアカウントによる説明記事をご覧ください！
↓記事投稿シリーズまとめ
↓次の記事