後輩に Markdown 勧める時
内容
後輩が付いた時に Markdown 記法を進めるシーンとそのあとのウケがいいのでどんな勧め方をしているかメモ
(よっぽど自分のメモの取り方にこだわりがないことを確認して)
Markdown とは
特定の記号を使って特定のサービスやテキストエディタで見出しなら少し大きいフォントサイズだったりボールドにしてくれたりといい感じのスタイルにしてくれる書き方。
B acklog・Trello のようなタスク管理ツールならだいたいリッチテキストにしてくれる。VsCode のように自動でリッチテキストに変換はされないが、色が付いたり見出しを判定してくれたり付加価値がおおい多い。
ただのメモ帳に書くとしてもパターンが決まるので見出しや箇条書きする時にここは〇ここは △ じゃあ次は □ にしよう。みたいに悩まなくなる。
記法の簡単なのですぐに使い始めることができる。
とりあえずこれだけ覚えればOK
-
見出し
-
箇条書き
- "-"ハイフンで箇条書きになる 例) - ほげほげ
- 後ろには半角スペースをいれること
- インデントを下げることで箇条書きの下に箇条書きとすることができる
-
チェックボックス
- "- [ ]"ハイフンで箇条書きになる 例) - [ ] チェックなし / - [x] チェックあり
- 後ろには半角スペースをいれること
- []括弧の中にスペースがないとリッチテキストにならない時もある。自分用のメモの際は面倒なのでスペースを入れない。必要なら対象だけ置換していれる。
これもできることは知っといて
以下は必要になったら調べて使う
- ボールド
- 取り消し線
- リンク
- テーブル
使うときに注意
基本共通な記法だけどサービスによって使えない記法があったりする。改行の入っていなかったりや半角スペース(インデント)によって反映されないミスがある。
VsCode で自動成形すると間違えがない。ただの自分としてはただのメモとして残したい時に成形されると改行が多い気がして見難いので自動成形されないようにしている。
リッチテキストにしたい時だけ手動で成型する。