連載
» 2017年05月29日 05時00分 公開

GitHubとSlackの連携の基本&知られざる便利機能Wiki、Releases、Graphs、Pulseこっそり始めるGit/GitHub超入門(13)(4/5 ページ)

[平屋真吾,クラスメソッド]

ソフトウェアに関するドキュメントをホスティングする「Wiki」

 Wikiとは、開発中のソフトウェアに関するドキュメントをホスティングするための機能です。例えば、下記のようなドキュメントをホスティングできます。

  • ソフトウェアの使い方
  • ソフトウェアの設計や意図などの説明

 ソフトウェアに関するドキュメントには、本連載第9回で解説した「READMEファイル」があります。READMEファイルは、ソフトウェアに関する情報を読者に素早く伝えるためのドキュメントです。一方、Wikiは長い文章を提供するのに適した機能です。

 長めのドキュメントを提供したい場合は、概要を「READMEファイル」に書き、詳細はWikiで提供するといいでしょう。

Wikiのトップを表示する

 Wikiに関する各種操作は、Wikiのトップから実行できます。

 GitHub上のリポジトリページを表示し「Wiki」タブを選択します。

図26 リポジトリトップページ

 Wikiのトップを表示できました。Wikiを1つも作成していない場合、図13のような表示になります。

図27 Wikiのトップ

1つ目のWikiページを作成する

 Wikiを作成するには「Create the first page」をクリックします。

図28 Wikiのトップの「Create the first page」ボタン

 Wiki作成ページが表示されます。一番上のテキストボックスにタイトルを、下半分のテキストボックスに本文を、一番下のテキストボックスに編集内容を記入できます。

イシューなどと同様に、本文にはMarkdownを使用できます。

図29 Wiki作成ページ

 タイトル用テキストボックスと本文用テキストボックスの間のエリアには、本文記入をサポートするためのタブやボタンがあります。これらのコンポーネントを使用すれば、プレビューの確認、Markdownの要素の挿入、文法に関する説明の確認などを行えます。

図30 本文記入をサポートするためのエリア

 一番下の「Save Page」をクリックすると、Wikiの作成を実行できます。ここでは、そのまま「Save Page」をクリックします。

図31 Wikiの作成を実行

 Wiki作成が完了すると、作成したWikiのページが表示されます。

 タイトルが「Home」のページは、Wikiのホームとなるページになります。リポジトリを見に来たユーザーがメインタブの中の「Wiki」を選択すると、まずこのページが表示されます。

 Homeページには、Wikiに関して読者に伝えたいことなどを載せるといいでしょう。

図32 Homeページ

2つ目のWikiページを作成する

 Wikiのホームとなるページが作成できたので、2つ目のWikiページを作成してみましょう。「New Page」をクリックします。

図33 Homeページ上の「New Page」ボタン

 1つ目のWikiページを作成したときと同じ要領で各値を記入します。

 ここでは、「References」というタイトルで、「Wiki機能に関するドキュメントのリンク集ページ」を作成してみます。

 「Save Page」をクリックして追加を実行します。

図34 Wiki作成ページ

 Wiki作成が完了すると、作成したWikiのページが表示されます。

図35 Referencesページ

Wikiページを編集する

 2つ目のWikiページが作成できましたので、次は「2つ目のWikiページへのリンク」をHomeに追加してみましょう。

 メインタブの中の「Wiki」(または右側のPagesエリア内の「Home」)をクリックしてHomeに戻ります。

図36 Homeページへ移動

 ページを編集するには「Edit」をクリックします。

図37 Homeページ上の「Edit」ボタン

 編集ページが表示されます。本文に「2つ目のWikiページへのリンク」を追加し、「Save Page」をクリックします。

図38 Wiki編集ページ

 Wiki編集が完了すると、編集したWikiのページが表示されます。編集した内容が反映されていることを確認できます。

図39 編集後のHomeページ

Wikiページの編集履歴を確認する

 Wikiページの編集履歴を確認するには、Wikiページのタイトルの下にあるリンクをクリックします。

図40 Homeページ上のリンク

 Wikiの編集履歴ページが表示されます。Wikiの各ページのファイルはGitで管理されており、保存を実行するたびにコミットが行われます。

 今回Homeを2回保存したので、2つの履歴が表示されています。

図41 Wikiの編集履歴ページ

 2つの履歴を選択して「Compare Revisions」をクリックすると、差分を表示できます。

図42 Wikiの編集履歴ページ上の「Compare Revisions」ボタン

 差分は図43のように表示されます。本連載第10回で紹介した「プルリクエストのページのFiles changedタブ」と同様の表示で差分を確認できます。

図43 Wikiの差分表示

Wikiページを削除する

 Wikiの特定のページを削除するには、編集ページを開き「Delete Page」をクリックします。

図44 Wiki編集ページ上の「Delete Page」ボタン

 「Delete Page」をクリックすると、ブラウザの確認ダイアログが表示されます。「OK」をクリックすると、ページの削除を実行できます。

図45 ページ削除確認ダイアログ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。