Gitbook + gitbook-plugin-umlで文字化けした場合

その他ツール

はじめに

　gitbook-plugin-uml - npmを使っていたら、図中に日本語を入れたときに文字化けで困りました。
　解決策を知るまでに苦労したので、メモ。

環境

  • Windows 7
  • Node.js v6.10.2
  • gitbook 3.2.2
  • gitbook-cli 2.3.0
  • gitbook-plugin-uml 0.1.7

事象

　PlantUMLの図中に日本語を入れると、作図された結果が文字化けをして、使い物にならないという困りごとがありました。

解決策

　以下のように文字コードにUTF-8を指定したうえで、UTF-8でファイルを作成すると文字化けを防げます。
　あと、改行コードが大事で、改行コードはLFにしておく必要があります。

{
  "root": ".",
  "title": "description",
  "plugins": ["uml"],
  "pluginsConfig": {
    "uml": {
      "format": "svg",
      "charset" : "UTF-8",
      "nailgun": false
    }
  }
}

さいごに

　PlantUML単体で使う場合の文字コード指定は、検索したらわりと簡単に見つかったのですが、gitbook-plugin-umlの文字コード指定はなかなかわからず、近くに座っている人に教えてもらいました。
　結局その人は、gitbook-plugin-umlのソースコード読んで発見していた。