【GitHub】READMEを日本語の目次で見やすくする

どういう変換！？(((っ・ω・)っ

（海を眺める白黒猫）

• 2018/12/22 現在

経緯

GitHubで職務経歴書を書きました。まだまだ見辛いので何とかしたいんですが、表にすると今度はマークダウンが見辛くなるので考え中です。

話が脱線しました。日本語で目次を作ったんですが最初は上手くいかなかったので、色々と方法を調べた話です。

GitHub公式で対応していないため、皆さん苦労されているようです。

gh-md-toc

• ver 0.6.2

$ cat README.md | ./gh-md-toc -
   * [職務経歴書](#職務経歴書)
      * [はじめに](#はじめに)
      * [目次](#目次)
      * [職務要約](#職務要約)
         * [基本情報](#基本情報)
         * [スキル](#スキル)
            * [言語](#言語)
            * [フレームワーク](#フレームワーク)
            * [その他](#その他)
         * [強み](#強み)
         * [やったことはないが興味があるもの](#やったことはないが興味があるもの)
      * [職務経歴](#職務経歴)

コンソール

いや、もうこれで解決でいいんじゃないでしょうか。VMのCentOS内で使ってみたんですけど完璧でしたもの。

言語の違いはあれど他は似たような感じで。

別のものもいくつか試したんですが、日本語に対応していないものもあり、都度確認は必要そうだと感じました。

見出しの要素

<h3>
  <a id="user-content-2019年04月-2019年12月-s社"
     class="anchor" aria-hidden="true"
     href="#2019年04月-2019年12月-s社">（中略）</a>
  2019年04月-2019年12月 S社
</h3>

noranuko13/curriculum-vitae

#2014年10月-2018年12月-s社 になってますね。スペースはハイフンに、半角英語大文字は半角英語小文字に変換されるようです。

アンカー以外にもidに user-content-2014年10月-2018年12月-s社 とあるので、どうやら他のことにも使ってそうです。

もし上記のようなツールを使う環境が直ぐに用意できない場合は、即席ですがこのような対応でもいけます。エンジニアらしくはないですけど。

おわりに

公式の toc 対応、どんな風になるんでしょ。