githubで日本語ドキュメントが文字化けする問題

githubに日本語ドキュメントを上げると、テキストエディタでは表示されていたはずの日本語が文字化けしてしまうと言った問題が発生することがありました。
githubでは日本語はつかえないのか!?とおもいましたが,普通に日本語でreadmeを書いている人もたくさんいます。
文字化けしてしまう際の対処法について以下に記述していきます。

文字コードの問題

結論から言いますと、github規定の文字コードではない文字エンコーディングで作成した日本語混じりのファイルをpushしてしまっていたため、文字化けが発生していました。

githubでは文字コードutf-8が用いられます。

私が作成したドキュメント(readme.md)の文字エンコーディングがiso-2202-jpとなっており、iso-2202-jpの文字列を無理やりutf-8として表示しようとし他ために文字化けしてしまったのです。

みなさんもgitにあげる日本語が入り混じった文書を作成する際は、テキストエディタの文字エンコーディング設定を一度見直してみると良いでしょう。

vimでのファイル書き込み文字コードの指定

set fenc=utf-8

vimでファイルの文字コードを指定する際は上記のような設定を行います。fencに文字コードを指定すると、書き出し時にその文字コードに文書が変換された後に保存されます。

iso-2022-jpのファイルをutf-8に変換したい場合には、

:set fenc=utf-8
:w

とすれば良いですね。

vimでの文字コードなど言語設定の話

vimで文字コードの設定を行う際に押さえておきたい設定や変数がいくつかありますが、みなさんはご存知でしょうか。

encording、fileencoding、fileencodings、language、などなど・・・

これらの変数にどのような値を設定すれば良いか、分かりますか?
vimの言語設定については、別ページに詳しくまとめてありますので、不安な方は一度そちらをご覧になってみてはいかがでしょうか。

MY ROBOTICS | vim エンコーディング・言語設定まとめ

以上、githubで日本語ドキュメントが文字化けしてしまう問題についてでした。