技術にゃんこの混ぜご飯

関東某所でITエンジニア生活を送るブログ主がチラ裏メモを放り込む場所

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

どういう変換!?(((っ・ω・)っ

  • 2018/12/22 現在

経緯

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

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

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

gh-md-toc

  • ver 0.5.0

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

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

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

見出しの要素

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

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

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

おわりに

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