こんにちは、Pythonエンジニア見習いです。今回は、madokoというソフトウェアで手軽にMarkdownのような記法を用い、高品質なドキュメントを書く方法とそのインストール方法について紹介します。まず、手軽にmadokoの素晴らしさを体感したい方や、エディタにこだわりのない人は、ここからオンラインエディタでmadokoを使うことが出来ます。

日本語を扱う

しかし、このまま使うのは問題があって、mdkをpdfにコンパイルしようとすると日本語が消失してしまいます。これの解決方法は、.mdkファイルの冒頭に以下のように書くことで解決できます。

https://gist.github.com/IlIlIlIl/fb4034d4983d1a26d64e006765cd4514

ローカルで使う

次に、特定のエディタにこだわりのある方は、npmでmadokoをインストールすれば使うことが出来ます。また、texlive-fullとmadokoのインストールされているdockerイメージをDocker hubにて公開しているので、どうぞご自由にお使いください。

ilil/docker-madoko-texlive-full

さらに、以前にも紹介したように、inotify-toolsを使えば、.mdkファイルを編集すると同時にmadokoが走るように出来ます。(Docker hubのイメージにもインストールされています)

madokoがもっと普及して、誰かがvimのプラグインをと切に願っております。

参考

• Madoko Reference