ドキュメント用webページを作ってみたい

前回の記事に書いた通り、自分用のドキュメント web ページを作ろうと考えました。 使用するツールは無料で色々遊べるらしいので、gitlab pages を使ってみます。

はじめに

gitlab pages の説明については非常に詳しい様々な記事があるため、そちらを参考にした方が良いです。 要するに、git ホスティングサイト (github や gitlab) に用意されているサービスの一つです。 html や markdown 形式で書かれたドキュメントを用意されているドメインで公開できるというものです。 無料で使用できる容量は 1GB 程となります。

普段は markdown を使いメモや個人のドキュメントを書いているため相性が良いだろうと考え利用してみることにします。 利用自体は非常に簡単で、リポジトリを作る際にテンプレートが用意されています。 それを使えばとりあえずはページを公開できます。

gitlab pages を使ってみる

早速、使って見るにあたり、pages で使用する静的サイトジェネレーターを決める必要があります。 詳しいことはまだよくわかっていないため、今回は gitbook と hugo の 2 つを試してみます。

gitbook

最初に目に入ったのは gitbook でした。 見た目がこれぞドキュメントサイトという感じで好感が持てたからです。 ファイルの管理も非常にシンプルです。

とりあえず、テストとして作ってみました。

f:id:nya03n:20220212214144p:plain
gitbook

見た目も非常にきれいです。

しかし、よく調べてみるとこの gitbook はオープンソースでの開発が終了しているようです。 gitbook.com 自体はクローズドソースで開発を続けているようですが、OSS 好きとしては微妙な感じです。 サイト自体も微妙に変更できない部分があるようなのでちょっと保留です。

hugo

次に試したのは hugo です。 最近非常に注目されていて、勢いのあるジェネレーターだそうです。(友人談) 正直、その手のことはよく知らないです。

hugo の場合は初期テンプレートがなかなか派手なものとなっています。

https://pages.gitlab.io/hugo/

テーマは自分で好きに変更できるらしいのでネットで好きなのを選べます。 いろいろ探してみて hugo book というテーマが良さそうなので決めました。

https://github.com/alex-shpak/hugo-book

早速、テーマを適応して作って見たのですが、現在進行系でエラーが連発しています。 生成されたページも随分違う見た目の物ができています。

f:id:nya03n:20220212214201p:plain
hugo-book

ローカルだと上手く生成できているので gitlab 上の問題だと思います。 もう少し戦ってみます。 簡単にいくと思ったんだけどな〜

おわり

ということで、現在進行系でエラーと格闘しています。 勉強を始める前に勉強が必要な状況になっています。

なかなか楽しんでます。