工学社から出ている書籍、はじめてのMarkdown―軽量マークアップ言語の記法と使い方を読了しました。
正直Markdownの書式くらいならネットで十分だと思っていたのですが、改めて知識を整理でき意外と良い本でした。「Markdownを普段何となく使っているけど、時々、改行などが思ったように反映されない…」みたいな人は一度読んでみると色々気づきがあるかと思います。
markdownエディタについて
本書では、エディタとしてMarkdown#Editorというソフトがお勧めしている。
…この本はちょっと前の出版なので、現在ならVisual Studio Codeが便利。
Visual Studio Codeだと、拡張子を*.mdでファイルを作り、”Ctrl+K V”でプレビュー画面を表示できる。ショートカットキーを忘れたときは、F1キーを押して”markdown”と入力すればリストとショートカットキーが表示される。
本文の段落分けについて
- 本文は通常pタグで囲まれる
- 文章を別の段落にしたい(2つのpタグに分けたい)場合は、markdownファイル内で改行を2連続で入れ、空行をはさむ
- brタグを入れたい場合は、行末に半角スペースを2つ入れて改行する
複数回改行したい場合は、”半角スペース”2つ+改行文字”の行を作る
引用文について(blockquoteタグ)
- インデントをつけるか、行頭に”>”文字を入れる
- blockquoteの中で改行したい場合は、”半角スペース”2つ+改行文字”
- “>>”でblockquoteをネストできる
二重にネストしたblockquoteから戻るには、”>”だけの行が必要
以下のようにすれば…
> 1行目 >> 1.1行目 >> 1.2行目 > > 2行目
こう表示される
1行目
1.1行目
1.2行目
2行目
箇条書きについて(liタグ)
- 行頭に”* “を入れればリストを作れる
- “*”記号の後ろには半角スペースが必要
- 本文とリストの間(リストを始める手前)には空行が必要
(本文のすぐ下の行に “* xxxx”を書いてもリストとみなされない)
箇条書きについて(olタグ)
- 数字+ピリオド+半角スペース”で、連番付きの箇条書きを作ることができる
- 一覧の列挙中に空行を入れると、連番が最初に戻る
- 一覧の途中で改行したいときは、行末に半角スペースを2つ入れる
- 箇条書き以外で行頭に、”1. “を持ってきたい場合は、”1\. “でエスケープできる
- さらに、”\”マーク自体を表示させたいときは、”\\”と2回重ねる
- 箇条書きに見出しと本文を書く際に、見出しだけ装飾したい場合は下記のように書く
1. **見出しの1つ目** 1つ目の内容説明 1つ目の内容説明2行目 1. **見出しの2つ目** 2つ目の内容説明 2つ目の内容説明2行目 1. **見出しの3つ目**
↓
1. 見出しの1つ目
1つ目の内容説明
1つ目の内容説明2行目
- 見出しの2つ目
2つ目の内容説明
2つ目の内容説明2行目 見出しの3つ目
強調、イタリック、下線について
2段落またいで、強調させることはmarkdown上ではできない
行いたい場合はhtmlタグを直接書くしかない“1*2*3=6″など、数式で掛け算記号を使いたいときに、誤って強調のマークとみなされる場合がある
このような場合は、アスタリスクの前に円マークを入れて”\*”とすればよい
画像について(imgタグ)
-  の形式で、画像を埋め込める
- !,[,],(,)の各記号の前後に空白を入れると正しく認識しないので注意
- “altのタイトル”の部分は省略してもよい
- 手前に文章があると、同じ行に表示される。改行したい場合は、文章の最後に半角スペース2個を入れるとよい
ソースコードの埋め込みについて(codeタグ)
- 埋め込むコードブロック全体をインデントするのが最も簡単
- インデントする際に、タブとスペース4つを混ぜないように注意
- コードブロックを終わらせるには、インデントのない改行を入れる
- 文章中へ
echo "hello<br />";
のような形でコードを埋め込む場合は、逆クォートで囲む - 逆クォートで囲んだコード中に、
export STIME=``date``
のような形で逆クォートを出したい場合は、逆クォートを2回書く
はじめてのMarkdown―軽量マークアップ言語の記法と使い方 (I・O BOOKS)
関連記事
コメントを残す