Markdownの良く分からなかったことまとめ
目次
記号
特殊記号の入力
特殊記号(*_\`#+-.![]{}())をそのまま表示したい場合はバックスラッシュ"\"でエスケープすること。
※環境によっては円マークと書こうとしたら、そもそもUnicodeで書くから円マークのわけはなかった…。
参考:Markdownで特殊文字をそのまま表示する
バッククォートをインラインコードに含めたい
ここが詳しい:Markdown でバッククオートを含むインラインコードを書くには - Qiita
例:``
(バッククォート2個)を書きたい場合は以下のようにする
\`\`\` \`\` \`\`\`
HTMLタグ
<br>を入力する
半角スペース2個を行末に入れる。
※QiitaのMarkdownの場合は改行1個に続けて書くと<br>と同じ効果になる模様
参考:Markdown、行末に半角スペース2つで<br>が挿入できる - ももいろテクノロジー
体裁
目次
Markdownの場合、以下のように目次(doctoc)をつけることができる。表示ブラウザによっては日本語の目次が使えないことがあるため注意。また、大文字と小文字は区別される。たとえばQiitaでは大文字の見出しのアンカーは全て小文字に変換されるため、アンカーを小文字にするとよい。
タイトルをクリックしたときに、そこが画面の一番上になるように、個人的には以下のようにタイトルを記載している。
- [hoge](#hoge)
- [fuga](#fuga)
...(中略)...
## [hoge](#hoge)
## [fuga](#fuga)
Markdownを解釈するシステムによっては、Markdownだけでアンカーがうまく効かない場合がある(Markdown Preview Plusはこれに該当)。
その場合は、<a>タグを利用し、アンカーをつける。
- [hoge](#hoge)
- [fuga](#fuga)
...(中略)...
<a id = "hoge"></a>
## [hoge](#hoge)
<a id = "fuga"></a>
## [fuga](#fuga)
参考:Markdownでのアンカーリンクの活用と目次の作成方法(テンプレ) - それわかるぅ〜
※Qiita + Firefox45.5.1では、このページの日本語の目次がきちんと作用することを確認済。
番号による箇条書き
番号をつけるときは接頭辞に「1.」とだけ書くのが楽で後からの追加・削除が楽。
1. hoge
1. fuga
1. mogu
このように記載しても、次のように正しく番号がつけられる。
- hoge
- fuga
- mogu
注釈の[^注釈]: は、最後の半角スペースまでが必要
コロンの次に続けて注釈文を書くと正しく解釈されない(ハマった)
注釈と箇条書きは両立しない
少なくともQiita上では注釈と箇条書きは両立しない模様。
いろはにほへと[^1]
- [^1]: ちりぬるを
注釈の文字列は、連番ではなく意味を持たせたほうがよい
後から内容を入れ替えたときに対応できるように、説明内容に即した文字列にしておいたほうがよい。
沖縄と大阪を入れ替えると、注釈文字列が1→3→2と並んで分かり辛い。直すのも面倒。
北海道[^1]
沖縄県[^2]
大阪府[^3]
沖縄と大阪を入れ替えても注釈の文字列は順番を示していないため、入れ替えの影響を受けない
北海道[^HOK]
沖縄県[^OKI]
大阪府[^OHS]
表の書き方
こちらが大変分かりやすいです:Qiitaのテーブルの書き方についてまとめた
表の整形したいよね的話
tidy-markdownがとても便利そう。(自分で作ろうとしたが既にあったか……)