—

Title: md_manual # front_matter_title: “md_manual”
Description: md記法マニュアル
Date: 2023-01-26
lastmod:

—

MD記法をマスターしよう^1

^1: YAML フロントマターが存在し、タイトルプロパティ (ブログ投稿で一般的に使用される) が含まれている場合、このルールはそれをトップレベルの見出しとして扱い、後続のトップレベルの見出しに対して違反を報告します。前付で別のプロパティ名を使用するには、front_matter_title パラメーターを介して正規表現のテキストを指定します。このルールで前付の使用を無効にするには、front_matter_title に “” を指定します。
MD025 – Multiple top-level headings in the same document Pico上、これに従うとグローバルメニューとして表示できなくなります。なので、yml ヘッダーとしては Title を使い、H２（##）をタイトルにして書き始めるか？、このトリガーを無視するか？になります。前者のほうが良いかも？

はじめに
１．大見出し（H２サイズ)
- （１）中見出し（H3サイズ)
  - a) 小見出し (H4サイズ)
２．リスト
３．ナンバリング
４．引用
５．取り消し線
６．リンク・画像の挿入^3
７．強調
８．チェックボックス
９．コード
１０．注釈
１１．テーブル
１２．エスケープ
- 参考

はじめに

例えば文章のタイトルでいうと、「ここはタイトルですよ」と設定することと、ここが「太文字」であることとは別。ワープロソフトは、「ここはタイトル」ということを明示せず、太文字にしたりしてタイトルであることを伺わせるようにする。これに対して、HTMLはタイトルのところを＜title＞＜/title＞タグで括って、タイトルであることを明示する。これがどんな大きさで、どんなフォントを使うのかっていう機能はスタイルシートを利用する。この、タグで明示することを構造化という。

見た目だけでタイトルを表せばよいという考えもあるが、視覚障害者にはこの手が通じない。視覚障害者向けの読み上げブラウザは文章の構造化がきちんと定義されていないと読み上げられない。

では、タグを書けばよいということになるが、複雑なタグをたくさん書かなければならない。もっと文章を手軽に構造化できないか、HTMLに変換できるより書きやすく読みやすいフォーマットはないかと考えられたのがマークダウンです。

１．大見出し（H２サイズ)

（１）中見出し（H3サイズ)

a) 小見出し (H4サイズ)

小見出しは段落が下げられていないので、現実には使えないと思う。 H4 サイズ以下はリスト化するのがよいと思われる。

２．リスト

リストマークは＊、+　または　-　。入れ子はリストマークの前に2つのスペース。更に入れ子にする場合はさらに2つ（計4つ）のスペース。

List1
入れ子
入れ子
入れ子から元に戻るには tab 削除

今度はマイナス記号で^2

^2:このルールは、順不同リストアイテムのドキュメントで使用されている記号が、構成されている順不同リストスタイルと一致しない場合にトリガーされますMD004 – Unordered list style。訳者【注】どうも「一つの文書内に異なるリストマーカーを使うな！」ということらしい。支障はないようだが。vs codeでは最初に使用したリストマーカーに修正される。

今日はめでたい
そんなに
こんな具合

次はプラス記号で

プラス記号
入れ子
入れ子
- 入れ子の入れ子
元に戻す

３．ナンバリング

マークは半角１.　または１）だ。同じ番号で構わない。変換してくれる。入れ子はナンバリングマークの前にスペース2つを挿入^3。更に入れ子にする場合は、更に2つのスペースのあとにナンバリングマーク。
^3:このルールは、リストマーカー (「-」、「*」、「+」、「1.」など) とリストアイテムのテキストの間のスペースの数をチェックしますMD030 – Spaces after list markers。訳者【注】リストマーカの後は半角スペースというのを守ったつもりが、vs code が自動的に挿入した半角スペースのあとに半角スペースが入っていることが原因。

入れ子はどうするのか？
ここは入れ子
ここは入れ子
1. ここは入れ子の入れ子
2. ここも上に同じ
a,b,c・・・（１）（２）などの表記はできないようだ
途中でのリセット、途中の番号からの場合は、数字を入れ替える
HTMLより直感的で覚えやすい

４．引用

引用は半角＞で実現する。入れ子はダブル＞（それぞれスペース必要）。入れ子から戻る場合は２回改行する（１回目で＞表示され、２回目で元に戻る）。

この文章は引用です。

２個入れると入れ子になる。

元に戻る

５．取り消し線

２つの〜で挟まれた部分が取り消し線となる。

文中に~~取り消し線を~~入れてみましょう。

６．リンク・画像の挿入^3

これは非常にわかりやすい。

これはさんぷるのURLです

画像の埋め込みは頭に！[タイトル]（リンク半角スペース “画像タイトル”）

７．強調

２つのアリタリスクで囲む。イタリック体（斜体）は３個のアリタリスク

テキストと比較すればどうだろうか。直感的で視認性が良いかと言われると疑問だし、プレビュー画面があるからなんとかという感じではなかろうか。結局はHTML記法よりマシ、ということではないだろうか。HTMLへの移植の点はテキストより良いのだろうか？これも疑問だな？

８．チェックボックス

書式は(*または+または-) [ ] の前後と中にも半角スペース。[]の中にｘを入れると終了後。チェックマークは x のみ。ほかの文字ではだめ（４つ目）。リストマークを使用するので、ここでもリストに関する約束事は同じ。

[ ] 除草剤を撒く
[x] 刈払
[ ] 今日の予定
[y] 今日の出来事を書くときにはどうしたらよいか
[ ] 必ずリスト表示と一緒に[]を使うこと。リストマークがないとチェックボックスにはならない。チェックマークは x のみ。そうでないと単なるリスト表示。
[x] リストと併用。中にx記号を入れるチェック
[ ] これだけではリスト表示にならない
[ ] 必ずリスト表示記号と一緒に使うこと。

９．コード

`（バッククォート）３個でコードの挿入。言語名(;ファイル名?)をバッククォートの後につけるとシンタックスハイライト^4

<p>迷いの中当てなく見上げた空を彩る星たち</p>
<p>嘘みたいに晴れた朝につながることを教えてくれた</p>

`^4:このルールは、保護されたコードブロックが使用されているが、言語が指定されていない場合にトリガーされますMD040 – Fenced code blocks should have a language specifie。訳者【注】言語の表示がないと、注意が喚起されるという意味らしい。

function hello(){
    return "hello world";
}

`以下はシンタックスハイライト表示。トリガー表示は出ていない。

<p>迷いの中当てなく見上げた空を彩る星たち</p>
<p>嘘みたいに晴れた朝につながることを教えてくれた</p>

function hello(){
    return "hello world";
}

１０．注釈

〔^1〕(注釈名は省略可)の後にはスペースなし。前にスペース必要。ページ連番は手動？

テキスト ^1 の中身を開く

text ^2 の中身を開く

ある男 ^3が道端で泣いていた

^1: A referebcet to the first footmode

^2: これは真っ赤なウソです

^3; これは長さが調整され、行頭が揃う効果あり。

１１．テーブル

（１）基本形

2行目の|—|—|—|で行を表示。列の個数と中には行っているデータの右痩せ、中央寄せ、左寄せを規定することができる。

住所	氏名	年齢
maruo	tateo	sankaku
koko	soko	asplp
lup	asu	asate

（２）セル内改行（セルの結合）

改行したい文字の後ろに＜/ｂｒ＞タグ挿入

トップ	第２位	第３位
丸	△ セル内改行第２行目	sikaku
これやれば	セルの結合の	見かけはまさにそれ

（３）セル内文字の左寄せ・中央寄せ・右寄せ

表の２行目にコロン:で調整。デフォルトは左寄せ

|：—|:—:|—:| <— こんな具合

左寄せ	中央寄せ	右寄せ
ちょっと長い文章	次の文章	最後の文章
効果の程は	どうですか	ちゃんとよせてありますか？
—:	:—	:—:
これは後付	そう	短い文章

注意 THだけ中央寄せ、その後は左寄せといった表示は不可能^5

^5:このチェックでは、セクションを区切るために強調 (太字または斜体) テキストが使用されているインスタンスを探します。代わりに見出しを使用する必要があります。これを修正するには、強調テキストの代わりに Markdown 見出しを使用してセクションを示します。

１２．エスケープ

バックスラッシュ+ 特殊文字

参考

DavidAnson/vscode-markdownlint

間違いやすい点の注釈付きMD記法