【個人開発でGitLab】GitLabのWikiの作成方法

GitLab

GitLabはプロジェクトごとにwikiが用意されています。
またwikiは複数作成することもできます。

今回はGitLabのwikiページの作成方法について説明します。

スポンサーリンク

GitLabのwikiの作成方法

GitLabの左側メニューから『Wiki』をクリックすると、wikiのページが開きます。

wikiページの作成画面を開くと、

  • wikiページのタイトル
  • wikiを書くフォーマット
  • wikiの内容
  • wikiを更新する時のコミットメッセージ

を入力して、作成することができます。

スポンサーリンク

GitLabのwikiの書き方

GitLabのwikiはいくつかのフォーマットを選択することができます。

選択できるフォーマットは、

  • Markdown
  • RDoc
  • AsciiDoc
  • Org

です。

Markdownの仕様について

GitLabのMarkdownは『GitLab Flavored Markdown』というフォーマットになります。
Markdownと一言で言っても、実は仕様が少しずつ異なったりするので、注意が必要です。

公式のドキュメントは下記のURLになります。

GitLab Flavored Markdown | GitLab
Documentation for GitLab Community Edition, GitLab Enterprise Edition, Omnibus GitLab, and GitLab Runner.

GitLab Markdownでできることについて簡単に整理します。

見出し

# H1
## H2
### H3
#### H4
##### H5
###### H6

文字の強調

*で括るか、_で括る

*XXXXXXX*
_YYYYYYY_

表のセルの文字位置を調整する場合は、2行目の『:』と『-』で設定します。
下記のコードであれば、左側のセルは左寄り、真ん中のセルは中央、右側のセルは右寄りの設定になります。

| header 1 | header 2 | header 3 |
| :-- | :-: | --: |
| cell 1 | cell 2 | cell 3 |
| cell 4 | cell 5 | cell 6 |

画像

画像を添付したい場所にドラッグ&ドロップすると、簡単に画像を貼ることができます。
画像のサイズを変更したい場合は、html形式で書くことで設定することができます。

リスト表示

* 番号無しリスト_1
* 番号無しリスト_2

1. 番号有りリスト_1
1. 番号有りリスト_2

plantuml

UML図を描くのにplantumlを使用することができます。
plantumlの書き方の詳細については、公式ドキュメントを参考にしてください。
簡単な例を下記に示します。

```plantuml
@startuml
Bob -> Alice : hello
Alice -> Bob : hi
@enduml
```

コメント

タイトルとURLをコピーしました