Markdown エディタが備えるべき性質のチェックリスト

ローカルのテキストエディタ上、または github.com 上で Markdown ファイルを読む&編集することが多い。備わってると嬉しい性質をチェックリストでまとめてみた。

チェックリスト

  • 基本的な文法をハイライトできること
    • [ ] 太字、イタリック体、見出し、リンク、引用、コードハイライト、リテラル
    • [ ] ハイフンリスト -listアスタリスク *list
    • [ ] リストのネスト(1インデント2スペース)
    • [ ] リストのネスト(1インデント4スペース)
    • [ ] 打ち消し線
    • [ ] Emoji :smile:
  • ハイライトが誤動作しないこと
    • [ ] アンダースコア _ 囲みをハイライトしないこと(snake_caseがハイライトされてうざい)
    • [ ] コードハイライト表記内の Markdown 文法をハイライトしないこと
    • [ ] 行頭の **太字** を太字として認識できること(リストではない)
  • 見出しの操作
    • [ ] 前の見出し/後の見出しにジャンプできること
  • 見出し一覧
    • [ ] 見出し一覧を常に表示しておけること
    • [ ] 見出し一覧に「現在カーソルが合っている見出し」を強調表示すること(現在位置の把握)
    • [ ] 選択した見出しにジャンプできること
    • [ ] 大中小見出しをインデントして表示すること
    • [ ] 見出しの並び替えができること
    • [ ] コードハイライト表記内の見出しを認識しないこと(Pythonのコメント構文など)
  • TOC(目次)
    • [ ] TOCを挿入できること
    • [ ] TOCを最新の状態に更新できること
    • [ ] 日本語の見出しに対しても正しくTOCを生成(クリックしたらちゃんと当該見出しにジャンプする)できること
  • Markdown 無関係の性質(ここは本質じゃないのでテキトー)
    • [ ] エディタのハイライト設定を簡単に変更できること
    • [ ] エディタの見出しシンボル設定(どんな行を見出しとして扱うか)を簡単に変更できること
    • [ ] エディタが軽い(一瞬でファイルを開ける)こと
    • [ ] エディタがバッテリー消費を食わないこと(MBAなら4時間は保たせたい)
    • [ ] エディタの設定を設定ファイルとしてインポート&エクスポートできること