GitHub Enterprise の活用と MkDocs による Web page 作成

Pocket

社内でもクローズドな GitHub 環境を使える GitHub Enterprise (GHE) は結構普及してきたように思います。
GHE をクローズドな GitHub として使う分には問題なかったですが、GitHub Gist Enterprise や GitHub Pages Enterprise として使う際にどうすればいいかがよく解らなかったので、調べたメモを書いておきます。

GitHub Gist Enterprise

GHE の URL を https://ghe.example.jp/ とします。
すると、GitHub Gist Enterprise は https://ghe.example.jp/gist/ あるいは、https://gist.ghe.example.jp/ とします。ただし、後者は専用のサブドメインが切られている場合に限りますので、大体は前者のパターンでアクセスすることをオススメします。

GitHub Pages Enterprise

同じく GHE の URL を https://ghe.example.jp/ とします。また、GHE のアカウントを daisuke とし、公開する GHE のリポジトリ名を test_page とします。
すると、https://ghe.example.jp/pages/daisuke/test_page/ という URL で GitHub Pages Enterprise として Web Page が公開できるようになります。
このときは MkDocs を使って Page を作成しました。

MkDocs による GitHub Pages Enterprise での Web page 作成

MkDocs は下記のとおり pip (Python) を使ってインストールするだけなので簡単かと思います。
MkDocs のインストールについて不明な点があればこちらを見てください。

MkDocks でページを作るにはファイルを置きたいディレクトリまで行き、下記コマンドで対象ディレクトリにプロジェクトを作成します。

この test_page の部分は GHE のレポジトリ名となります。
そうすると、test_page の下に mkdocs.yml という MkDocs の設定ファイルと docs というディレクトリができているはずです。
まずは、docs の中にコンテンツとなる Markdown ファイルを作成していきます。ファイルができたら下記コマンドでビルドをします。

ビルドが完成したら、docs と同じ階層に site というディレクトリができているはずなので、Web 公開する場合にはこちらの中身をまるっと公開します。
また、GitHub Pages (Enterprise) で公開したい場合には test_page をまるっとリポジトリにあげた後、下記コマンドを実行してください。

すると gh-pages ブランチにビルドした結果を push してくれ、Github Pages (Enterprise) として Web が公開されるようになります!!!

また、下記コマンドでマテリアルデザインに対応できるなど、色々と使い勝手がありますので、是非、色々と触って貰えればと思います。

Filed under: daily life, techTagged with:

No comment yet, add your voice below!


Add a Comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

Comment *
Name *
Email *
Website