Hidemaru Markdown

秀丸エディタで Markdown 執筆環境を実現するためのオレオレセットです。

• Hidemaru Markdown
  • 現在サポートする機能
  • (1)ハイライト
    • インストール
    • （参考）ハイライト対象の方針
  • (2)アウトライン表示
    • インストール
  • (3)目次挿入
    • インストール
    • 使い方
  • (2020/02/29 追記) 試験的に黒背景版も追加してみました
  • License
  • Author

現在サポートする機能

• (1)ハイライト表示
• (2)アウトライン表示
• (3)目次挿入（外部ツールを使います）

(1)ハイライト

基本的な文法とカーソル位置を見易く表示します。

インストール

• その他 > ファイルタイプ別の設定 を開く
  • .md ファイル用の設定を適当につくる
  • デザイン > 強調表示 > 読み込み ボタンから md.hilight を読み込む
    • この時、全てのチェックボックスをオンにしてください

インストール後、.md ファイルを開くとハイライト表示が適用されているはずです。

（参考）ハイライト対象の方針

ハイライト対象となる文法は厳密な Markdown 仕様には従っておらず、オレオレなところがあります。一部については方針をまとめておきます。

• Markdown 文法関連
  • 太字
    • ⭕ **太字**
    • ❌ __太字__
    • アンダースコアは __snake_case__ のアンダースコアと被るので嫌い
  • 斜線
    • ⭕ *イタリック体*
    • ❌ _イタリック体_
    • アンダースコアは _snake_case_ のアンダースコアと被るので嫌い
  • リスト
    • ⭕ - リスト
    • ❌ * リスト
    • アスタリスクは太字と被るので嫌い
    • 順序付きリストは「単に日本語として書いた 1. XXXX も強調されて読み辛いのでしない
  • 水平線
    • ⭕ ***
    • ❌ ---
    • 色んな書き方があるがバリエーションがあってもわかりづらいので上記で統一
    • ハイフンはパっと見リスト表記と被るので採用しなかった
  • 大見出し
    • ⭕ # 大見出し
    • ❌ 大見出し\n======== ← 二行表記のやつ
    • 二行表記見出しはハイライトしづらいので使わない
  • 引用、テーブル、リンクなど
    • 下手にハイライトさせるとカラフルになって見辛いのでしない
• GitHub Flavored Markdown
  • 打ち消し線
    • ⭕ ~~打ち消し線~~
    • よく使う
  • Emoji（絵文字）
    • ⭕ :smile:
    • よく使う
  • TODOリスト(チェックボックス)
    • - [] 未完了TODO ← 強調しない
    • - [x] 完了したTODO ← 強調する（打ち消し線と同じ文法）
    • 終了した TODO を見やすくしたいので導入
• その他独自表記
  • 括弧系
    • ⭕ 「カギ括弧」
    • ⭕ 『二重カギ括弧』
    • 日本語文章やメモを書くのによく使う

(2)アウトライン表示

Markdown の見出し表記をアウトラインとして扱えるようにします。これにより以下メリットがあります。

• アウトライン解析の枠に見出し一覧を表示できる
• 前/次の見出しにキー一発でジャンプできる

インストール

• 上記ハイライトをインストールする
• ウィンドウ > アウトライン解析の枠 をオンにしてアウトライン枠を表示させる
• その他 > キー割り当て から以下を割り当てる
  • Alt + Up: 前の見出し
  • Alt + Down: 次の見出し

キー割り当てはお好きな割り当てで OK です。

(3)目次挿入

intoc を用いて、目次(Table Of Contents)を生成して挿入できるようにします。Python が必要なため、導入ハードルは高いです。

インストール

• intoc をインストールする
  • Python 環境が必要です
  • GitHub の知識が必要です
  • 詳しい解説は割愛します 😓
• launch_intoc.mac.sample を launch_intoc.mac にリネーム後、intoc.py のパスを修正する
• その他 > マクロ登録 より launch_intoc.mac を登録する
• (任意) 呼び出しやすいよう当該マクロをツールバーに配置したりキー割り当てしたりする

使い方

• 秀丸エディタで .md ファイルを開く
• 目次を挿入したい行に <!-- toc --> と書く
• 当該マクロを呼び出す

ただし外部(intoc.py)からファイル内容を変更する挙動になるため、以下ダイアログが出ます。

(2020/02/29 追記) 試験的に黒背景版も追加してみました

→ md_dark.hilight

License

MIT License

Author

stakiran