経緯
npm run deploy で GitHub Pages にお手軽デプロイでnpmにgh-pagesというパッケージがあることを知りました。
やりたいこと
package.jsonがないような、例えばJavaScript以外の言語のプロジェクトでも対応できます。
これの方法で、各種ドキュメント生成ツール、例えばC/C++のDoxygenとかHaskellのHaddockで自動生成されたhtmlファイルとかをGitHub Pagesで簡単に公開できます。
(git submodule ...とか面倒なことは一切不要です！)
やりかた
1. npmをインストール
各自で自分のOSにあった方法でnpmコマンドが使えるようにインストールしてください。
2. gh-pagesをインストール
gh-pagesをコマンドとして使うのでグローバルにインストールしてしまいます
npm install -g gh-pages
3. 好きなディレクトリをGitHub Pagesに上げる
以下のコマンド好きなディレクトリをルートとしたGitHub Pagesとなります
gh-pages -d <GitHub Pagesにしたいディレクトリのパス>
これで完了です。「Published」と出力されたら無事にpushできている思います。
その他
コミットメッセージを変える
デフォルトのコミットメッセージが「Updates」なので、それを変えるには-mオプションでできます
# 例：
gh-pages -m "[AUTO] Update document" -d <GitHub Pagesにしたいディレクトリのパス>
CIを回らないようにする
Travis CIなどのCIを回しているときに、Pushをトリガーに自動的にテストが始まるのを止めたいときがあります。
そんなときは、以下のようにコミットメッセージに"[ci skip]"を含めるといいです。
# Travisのときの例：
gh-pages -m "[AUTO] [ci skip] Update document" -d <GitHub Pagesにしたいディレクトリのパス>