Hugo で使える Markdown の記法
Posted / Update 2019-03-06
はじめに
Markdown には、基本となるものから、機能拡張されたものまであり、使用する環境によって微妙に使えるコマンド、使えないコマンドがあるようです。
この前、外部リンクを開くための記述をネットで探して入れてみましたが、残念ながらココでは動かず・・・。
ということで、Hugo で使える Markdown を、自分のためにまとめておきます。
Markdown の中で HTML を書いちゃえばなんとでもなりますが（笑）
Hugo で使える Markdown 記法
普段、よく使うものだけ。
正式な記法であったり、もっと辞書的なものをお求めの方は、Google先生
にお尋ねください。m(_ _)m
見出し（h）
# の数で h1 ～ h5 を表し、その右に見出しの文字列。
# 見出し（h1）
## 見出し（h2）
### 見出し（h3）
#### 見出し（h4）
##### 見出し（h5）
改行（br）
行末にスペースを2つ付けます。
見えませんけど、想像してください（笑）
実際に改行していなくても、スペース2つが間に入っていれば、続けて書いていてもそこで改行されます。まぁ、<br> と同じです。
改行前の文章
改行後の文章
強調（strong）
** で文字列を挟む。
** hoge **
画像挿入（img）
タイトルは省略可能。
リンク（a href）
残念ながら、target は指定できない。
どうしてもやりたい場合は、HTML で書く。
テキストリンク
タイトルは省略可能。
[hoge](https://hoge.com)
[hoge](https://hoge.com "タイトル")
画像リンク
タイトルは省略可能。
[](https://hoge.com)
[](https://hoge.com)
コード（code）
文中に差し込むコードは ` （バッククォート）で挟む。
文字列 `コード` 文字列
整形済みテキスト（pre）
単純にコードを記述する場合は、タブで行頭を開ける。
コードの前後にあたる行は空行でないとうまく読み取れないことあり。
また、特定のフォーマットでシンタックスハイライトを付ける場合は、```html とかにする。
htmlの部分は、php、md・・・いろいろ入れられるので、ケースに合わせて使用する。
[hoge](https://hoge.com)
[hoge](https://hoge.com)
水平線（hr）
*** もしくは --- で水平線が書けます。
前後に文字列が入ってはいけません。
***
取り消し線（s）
~~ で取り消す文字列を挟みます。
~~取り消す文字列~~
WordPress でも使えるよ［2019-03-06］
余談ですが・・・。
WordPress 5.0 でお目見えしたブロックエディタ（旧呼称 Gutenberg）は、Markdown に対応しています。
エディタで書いてから、ブロックエディタに貼り付けるとうまい具合に変換してくれました。
注意点
VSCode のように、Markdown の書式にあわせて文字色を変えてくれる優秀なエディタの場合、コピーした際にその情報まで持っていってしまい、うまく反映ができません。
面倒ですが、以下のような方法をとってください。
- Markdownモードで作成 → テキストモード or メモ帳 に貼り付け＆コピー → ブロックエディタに貼り付け
- 最初からテキストモード or メモ帳みたいなシンプル機能のエディタを使う
またよく使うものが出てきたら追記します。
ここに分かりやすく書いてあった。
Markdown Cheatsheet