今日からプロジェクトで使えるGitLabのWiki構築手順！

# リポジトリ用のWikiを作成するメリット

ホスティングサービスにおけるWikiの機能は、リポジトリ自体にドキュメントを含めたくない場合や、他のクラウドサービスにリポジトリ用のドキュメントを保存するのも…といった場合に便利な機能となります。

また、GitHubやGitLabどちらでも、サイト側でWikiの操作ができる以外にもWiki自体をリポジトリとしてCloneを行い、ローカルでまとめて変更を行うことも可能です（でもサイト側だと画像をD&Dできるのでそちらの方が楽です）。

では、実際に作成する手順を紹介します。今回はサイト側からの編集をメインとします。

また、GitLabはアイコン押下からの`Profile > Preferences > Localization`を日本語に設定しています。



# Wiki編集の手順

Wikiは各GitLabのリポジトリに対して、デフォルトで有効になっており、簡単に構築することが可能です。

ただし、Wikiの編集はユーザーの権限毎に許可されている操作が異なります。
ユーザー権限に関しては以下の記事の方で言及しています。

[【UE4】アセット管理のためにGitLabに登録し、使用する](https://qiita.com/4_mio_11/private/2957739123f2db9e9db6#%E3%83%A1%E3%83%B3%E3%83%90%E3%83%BC%E3%81%AE%E3%82%A2%E3%82%AF%E3%82%BB%E3%82%B9%E6%A8%A9%E9%99%90%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)



## Wikiページへアクセス（Guest以上）

まずはWikiを作成したいプロジェクトのページを開いてください。

プロジェクトページの左サイドバーにて、Wikiへアクセスするためのアイコンがあります。

こちらを押下することでWikiのTopへと移動できます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/640cc994-1ae8-9c77-b7c7-f1dad7f0c200.png)



## WikiのHomeページを作成する（Developer以上）

Wikiへの初回アクセス時と、Homeページを作成していない場合は、自動で新規ページの作成画面が表示されます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/092aa783-8239-347b-ea84-13dff343fdc8.png)



HomeページはWikiのトップ画面となるので、ここにチームでよく使うサービス内のプロジェクト用フォルダへのリンクなどを加えておくと、メンバーもアクセスしやすくなると思います。ちなみに`Content`の`Write`に張り付けたい画像を直接ドラッグアンドドロップするか、クリップボードにコピーしてある画像をペーストすることで、自動アップロードされ、`Write`内に画像を入れることができます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/2ab43f9f-39c5-acb2-5c2e-033e32428652.png)



## WikiのClone（Guest以上）

Wiki自体をリポジトリとしてCloneすることができます。

Wikiページを開いた状態だと、画面右上に`リポジトリをクローン`という表示があります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/f57d3d5c-9da9-c629-0b3f-1b0e01620a3e.png)

ここを押下することで、クローン画面へと移動します。

移動したら、任意のClone用のURLをコピーして画面の`Wikiをクローン`という項目を参考にしてCloneしてください。私は`HTTPS`を選択し、Cloneしたリポジトリ内容はVSCodeなどのエディタから操作を行っています。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/c9e2c0c9-be33-3938-5aee-681c88a863e6.png)



## Wikiに新規ページを作成する（Developer以上）

Wikiに新しいページを追加するのはWikiページ内であればどこからでも可能です。緑の`新しいページ`というボタンを押下することで以下の`Create New Page`画面へ移動できます。ちなみに`Content`の`Write`の横に`プレビュー`というタブがありますが、そこで記述した内容を確認することができます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/fabaf5db-7bb3-c52b-47c0-f06b6e4b78df.png)

番号順に解説をしていきます。



### ①ページのタイトルと階層の設定

ページ名およびページが属する階層を設定することができます。

単にページ名だけを記入した場合は、Homeページと同等の階層に入るのですが、`階層名/ページ名`と入力することで、任意の階層下にページを作成することができます。ここでの階層は、ファイルを格納しているフォルダと同じようなものと考えて頂ければ大丈夫です。実際、CloneしたWikiではマークダウンファイルを任意の名前のフォルダ下に移動/ 作成することでWiki画面上でも階層が表示されます。

上記の設定を行うと以下のような階層構造がサイドバーに表示されます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/b90fbf57-819c-0ae2-6ee9-e33e5b1b2787.png)



### ②目次の自動生成

`[[_TOC_]]`と記述することで、各ヘッダーを表示する目次を自動生成できます。`[[_TOC_]]`やヘッダーを作った時もそうなんですが、記述の下には必ず改行を入れて一行空けてから文を記述してください。



### ③便利ツール

markdownの記述にて、太字や斜体、箇条書きリストや番号付きリスト、テーブルの作成などをボタン一つで追加することができます。Markdownの記述に慣れてない方には優しい機能だと思います。



### ④コミットメッセージ

Wiki自体がリポジトリとなるので、ここで変更差分を含めたコミットのコミットメッセージを設定することができます。とはいっても僕は面倒くさいので結構そのままにしちゃったりしてます。



## Wikiページを削除する（Maintainer以上）

削除したいページに移動し、編集ボタンを押下します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/f1df6b4b-6b09-e188-0309-3b8d29d3ccd6.png)

編集ページへ移動すると、`ページの履歴`ボタンの横に`削除`ボタンがあるので、それを押下してください。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/36899/dda1b53a-6b39-bf72-952a-a7774fc4d8b4.png)



# 参考

- [GitLab wiki で目次を自動生成する]( https://qiita.com/zyamu/items/34fd8903bbb7787a5543 )
- [ Wiki (公式)]( https://gitlab.com/help/user/project/wiki/index#moving-a-wiki-page )