概要
Gitlab の wiki 機能をいろいろと試してみました
ページの作り方やサイドバーの編集方法を紹介します
環境
- CentOS 7.7.1908
- docker 19.03.4-rc1
- GitLab Community Edition 12.8.7
- Ruby 2.5.5p157
- gollum 4.1.4
gitlab の立ち上げ
過去の記事を参考に起動しましょう
プロジェクトの作成
適当に作成しましょう
階層付きの Wiki ページの作成
Wiki ページを作成するときのタイトルに「/」を入れることで階層化することができます
特定の階層の Wiki の一覧を表示する方法はない
どうやらこの機能はないみたいです
feature request 的なのはあるのでもしかするとそのうち実装されるかもしれません
現状は wiki のページをすべて確認できるページで確認するしか方法はないようです
[all pages](pages)
_sidebar.md を編集する
Wiki のサイドバーはカスタマイズ可能です
単純に _sidebar というページを WebUI 上で作成しても良いですがせっかくなので clone してみました
git clone http://192.168.100.8/root/pjct.wiki.gitcd pjct.wikivim _sidebar.md
# Sidebar
Hello my sidebar!- git add .
- git commit -m “Add custom _sidebar”
- git push -u origin master
これでサイドバーをカスタマイズすることができます
gollum を使ってみる
内部的に Wiki は gollum という git ベースで管理できる Wiki システムで動作しています
gollum にはマクロが備わっておりそれらのマクロを gitlab 上でも使うことができます
ローカルで動作確認してから push してみましょう
まずは gollum をインストールします
yum install -y libicu-develgem install gollum
ローカルに clone した wiki を gollum で動作させてみましょう
cd pjct.wikigollum
これでローカルで wiki ページが立ち上がるので 0.0.0.0:4567 ポートにブラウザでアクセスして動作確認してみましょう
試してにマクロが使えるか確認してみます
一度 Ctrl+c で gollum を停止します
- vim home.md
[all pages](pages)
<<Navigation("dir1 TOC", "dir1", true)>>- git add .
- git commit -m “Update home”
gollum
これで再度ブラウザで確認すると「dir1」階層に作成した wiki ページの一覧が表示されると思います
これを使えば階層化したページの一覧表示ができそうです
ローカルで確認して問題なければ push しましょう
git push -u origin master
これで gitlab 側を確認すると dir1 配下のページの一覧が確認できると思ったのですがどうやら gitlab ではまだマクロに対応していないようです
https://gitlab.com/gitlab-org/gitlab/issues/25105
せっかくページの一覧を表示できると思ったのですが残念です
一応これもリクエストがあるのでそのうち実装されるかもしれません
最後に
gitlab の wiki 機能を簡単に触ってみました
ページの一覧を表示する機能はまだないようです
0 件のコメント:
コメントを投稿