Mithrilのウェブサイトの日本語訳を公開しました。Mithrilおもしろいんでぜひ遊んでみてください。
今日は、Mithrilの日本語ドキュメントを置いている、js.orgドメインの登録の仕方のお話です。JavaScript関連のモジュールを公開している人は使ってみるとなんかカッコいいURLが取れます。
ドキュメントの準備
まずはgithub pagesにウェブサイトを乗っけます。github pagesについてはもういろいろ紹介があるので特に説明はしません。今回のドキュメントは、以下のURLで翻訳をしています。
翻訳にあたっては、http://www.transifex.com/とかを使っても良かったんですが、今回は一度じっくり使い込んでみようと思っていたOmegaTを使ってみました。OmegaTをダウンロード後に、このリポジトリをcloneして、OmegaTでディレクトリを指定して開きます。
今回はHTMLファイルを直接ソース(source)に入れています。一度翻訳した文が似ている参考訳文として出てくるので、リファレンスとかを訳すのがとても簡単です。一通り翻訳したら、ファイル - 訳文ファイルを生成を選択すると、訳語が置き換わったHTMLファイルがtargetディレクトリに生成されます。
このプロジェクト全体をgitに入れて管理していますが、gh-pagesブランチに入れたいのはこのtargetディレクトリだけです。target/index.htmlがgh-pagesブランチのルートのindex.htmlになるようにします。以下のsubtreeコマンドを使うと、ディレクトリの一部を別のブランチとして切り出すことができます。
$ git subtree -P target -b gh-pages
あとはこのリポジトリをアクティブにして、githubにpushしておきます。
$ git checkout gh-pages
$ git push origin gh-pages
今回はOmegaTで翻訳したHTMLを投入しましたが、公式にも書いてあるJekyllを使った方法を使ってもいいですし、HTMLを自分で用意しても問題ありません。なおアンダースコアを含むファイルやディレクトリがあると、Jekyllが悪さするので、gh-pagesブランチのルートに .nojekyllという名前のファイルを置いておきます。
js.orgへの登録
これまでの説明で、github pagesができました。mithril-jaの実体は https://shibukawa.github.io/mithril-ja/ というところにあるドキュメントです。まずはここまで確実にやりきってください。
できたウェブサイトを*.js.orgというURLでアクセスできるようにします。規約がここにあるので、軽く流し読みしてみてください。まあよくある免責事項とかです。
まずはURLを決めます。 http://hyanore.github.io/fuegaso というURLだった場合、 http://hyanore.js.org というURLにすることもできますし、 http://fuegaso.js.org というURLにすることもできます。
URLが決まったら、 CNAME という名前のファイルをgh-pagesブランチのルートに追加します。ファイルには一行、登録したいURLを入れておきます。mithril-ja.js.orgのCNAMEファイルは以下のとおりです。
mithril-ja.js.org
忘れずにgithubにpushしておきます。
つぎに、dns.js.orgのリポジトリにpull requestを送ります。
cname-active.jsを開いて、登録したいページの情報をJSONに追加します。
mithril-ja.js.orgの登録時のpull requestはこんな感じです。アルファベット順にならんでますので、登録したい名前をキーとして挿入して、値にリダイレクト先のURLを入れておきます。
, "mithril": "lhorie.github.io/mithril"
+ , "mithril-ja": "shibukawa.github.io/mithril-ja"
, "mmcq": "nikola.github.io/MMCQ"
わざわざcloneしなくても、ブラウザ上で鉛筆ボタンを押して、ブラウザ上で行を追加してそのままpull requestが出せます。あとは、indusさん(ドイツ在住)が確認してマージしてくれれば、晴れてサブドメインが開通します。
めでたしめでたし。