Git リポジトリを Wiki に公開する

Azure DevOps Services |Azure DevOps Server 2022 および Azure DevOps Server 2019

Git リポジトリで既に管理しているコンテンツを Azure DevOps Wiki に発行できます。 リポジトリには、ソフトウェア開発キット (SDK)、製品ドキュメント、README コンテンツなどのファイルが含まれている場合があります。 1 つのチーム プロジェクトに対して複数の Wiki を発行することもできます。

Markdown (.md) ファイルを Wiki に公開すると、次のような利点があります。

• コンテンツを管理ページ シーケンス構造に整理する
• 目次を参照してフィルター処理する
• コンテンツの新しいバージョンを発行する
• コード ベースを管理するのと同じ方法でコンテンツを管理する
• Wiki 検索機能を使用して Wiki を簡単に 検索 する

詳細については、「 プロビジョニングされた Wiki と Wiki として発行されたコード」を参照してください。

この記事では、Azure DevOps Web ポータルと Azure DevOps CLI を使用して、Wiki に発行されたコンテンツを追加および編集する方法について説明します。 Git リポジトリ内のコードで共同作業するのと同じ方法で、オフラインで作業し、Wiki コンテンツを更新することもできます。 詳細については、「オフラインで wiki ページを更新するを参照してください。

前提条件

Wiki を開く

サポートされている Web ブラウザーを使用して Azure DevOps プロジェクトに接続し、Wiki を選択します。

チーム プロジェクトを切り替える必要がある場合は、 Azure DevOps を選択して 、すべてのチーム プロジェクトとチームを参照します。

Git リポジトリを Wiki に公開する

このセクションでは、Git リポジトリを Wiki に発行する方法について説明します。 ブラウザーで Azure DevOps UI を直接操作することも、Azure DevOps CLI を使用することもできます。

az devops wiki create [--mapped-path]
                      [--name]
                      [--org]
                      [--project]
                      [--repository]
                      [--type {projectwiki, codewiki}]
                      [--version]

az devops wiki create --name "My Code Wiki" --type codewiki --repository MyCodeRepo --mapped-path /wikis --version main --output table

ID                                     Name            Type
------------------------------------   -------------   --------
0000aaaa-1b1b-2c2c-3d3d-444444eeeeee   My Code Wiki    codewiki

ページの編集、名前変更、または削除

Azure DevOps Web ポータルでは、Wiki ページを編集、名前変更、または削除できます。

1. プロジェクトで、 Repos>Files または Code > Files を選択します。

2. ファイルの一覧で、作業するページを選択します。

3. ファイル の [その他のオプション を選択し、アクションを選択します。

   

以降のセクションでは、アクションを完了する方法について詳しく説明します。

ページを編集する

ファイルを編集するときに、リンクを使用して変更をプレビューするか、以前のバージョンから行われた変更を強調表示します。

• 変更を破棄するには、 Cancel を選択します。 サポートされている Markdown 機能の詳細については、Markdown の使用に関する Syntax ガイダンスを参照してください。

• 完了したら、更新に関するコメントを追加し、[ コミット] を選択します。

  

  プル要求を作成するためのリンクが自動的に表示されます。 Wiki ブランチを直接編集している場合は、このメッセージを無視できます。

  

ページの名前を変更する

Wiki TOC に表示するすべてのページでは、Markdown (.md) ファイルの種類を使用する必要があります。 [名前の変更] アクションを使用すると、ファイル拡張子の変更など、ファイルの名前を変更できます。

次の例では、 new-home-page.md ファイルの名前を New-Home-Page.md に変更します。 対応するページが Wiki TOC に表示され、ラベル "新しいホーム ページ" が表示されます。

ページタイトルはケースセンシティブで、フォルダー内で一意である必要があります。 タイトルは 235 文字以下にする必要があります。 詳細については、「 ページ タイトルの名前付け制限」を参照してください。

ページの削除

Wiki に表示しない Markdown ファイルは、発行されたフォルダーから削除できます。 ファイルを.order ファイルに含めた場合、.order ファイルから対応するページエントリを削除してください。 詳細については、「 .order ファイルのページ シーケンスの変更、追加、または更新を参照してください。

ページまたは複数のページを追加する

発行した Wiki にページを追加するには、いくつかの方法があります。

• Wiki ルート フォルダーまたはサブフォルダーにファイルを追加する
• Wiki ルート フォルダーまたは任意のサブフォルダーにファイルをアップロードする
• wiki TOC でページ シーケンスを指定する .order ファイルを追加または更新する

更新ごとに、Wiki リポジトリに変更をコミットする必要があります。 次に、発行したリポジトリの Wiki を更新して、変更を確認します。

Web ポータルからページを追加する

発行した Wiki にページを追加するには、次の手順に従います。

1. Azure DevOps Web ポータルで、発行された リポジトリの Repos>Files または Code>Files に移動します。

2. リポジトリ の [その他のオプション ] を選択し、[ 新規>File] を選択します。

   

3. ダイアログで、Markdown (.md) ファイルの種類を含む新しいファイルの名前を入力します。

   ファイル名は、Wiki TOC に表示するページ タイトルに対応している必要があります。 ページ タイトル内のスペースを、ファイル名のハイフン (-) に置き換えます。 ページタイトルはケースセンシティブで、フォルダー内で一意である必要があります。 タイトルは 235 文字以下にする必要があります。 詳細については、「 ページ タイトルの名前付け制限」を参照してください。

   次の使用例は、wiki TOC に表示される Page-4.md という名前のファイルをページ タイトル "Page 4" で追加します。

   

   を選択してを作成します。

4. ページがファイルの一覧に表示されたら、ページを選択し、[ 編集] を選択します。 ページの内容を入力します。 詳細については、「 Markdown ファイル、ウィジェット、Wiki、pull request コメントのSyntax ガイダンスを参照してください。

5. 完了したら、[コミット] を選択して、発行済みリポジトリに新しいページを追加 します。

フォルダーへのファイルのアップロード

また、発行された Wiki のフォルダーにファイルをアップロードすることもできます。 このオプションは、追加する既存のコンテンツがある場合に便利です。

1. Azure DevOps Web ポータルで、発行された リポジトリの Repos>Files または Code>Files に移動します。

2. リポジトリ の [その他のオプション を選択し、[ ファイルのアップロード] を選択します。

   

3. [ コミット ] ダイアログで、アップロードするフォルダーとファイルを選択します。

   

4. 完了したら、[ コミット] を選択して、発行されたリポジトリにファイルをアップロードします。

サブページがあるページを追加する

Wiki のページにサブページを含める場合は、同じ名前の Markdown ファイルとフォルダーが必要です。 ファイルとフォルダーは、同じ Wiki フォルダーに存在する必要があります。

1. 「Web ポータルからページを追加する」の手順に従って、新しい Markdown ファイルを作成します。

2. 対応するフォルダーを作成するには、リポジトリの [その他のオプション ] を選択し、[ 新規>フォルダー] を選択します。

3. [ 新しいフォルダー] ダイアログで、Markdown ファイル名と同じフォルダー名を入力します。

   

   を選択してを作成します。

4. Wiki ファイルの一覧で、新しいフォルダーを選択します。 1 つ以上のファイルをサブページとしてフォルダーに追加します。

.order ファイルを追加または更新する

発行されたリポジトリにファイルまたはフォルダーを追加した後、最後の手順は、新規または更新されたフォルダーの .order ファイルを追加または更新することです。 ページ シーケンスを更新して、新しいファイルとフォルダーが Wiki TOC に想定どおりに表示されるようにします。

詳細については、「 .order ファイルのページ シーケンスの変更、追加、または更新」を参照してください。 .order ファイルにリストされていないファイルは、ページ シーケンスのアルファベット順リストの末尾に追加されます。

.order ファイルを使用してページ シーケンスを変更する

Wiki ルートの .order ファイルは、ルート レベルのページの表示シーケンスを指定します。 このファイルは、 ウェルカム、 サポート、 rel-2025 など、フォルダー内の Markdown ファイルに対応するページ名のプレーン テキスト リストです。 Wiki 内の各フォルダーには、そのフォルダーのページ シーケンスを定義する .order ファイルもあります。

フォルダーの注文シーケンス ファイルを設定するには、次の手順に従います。

1. [ コード > ファイル] ページで、[ 新しいファイル] を選択します。 ファイルに .order という名前を 付けます。

2. ファイルの内容を編集して、フォルダー内の Markdown ファイルの表示順序を定義します。

   Wiki ユーザーに表示するフォルダー内の各ページ ファイルに対応するエントリを追加します。

   ページ タイトルでは大文字と小文字が区別されます。 エントリ テキストは、ファイル名で使用されるページ タイトルと大文字と小文字と一致する必要がありますが、Markdown (.md) ファイルの種類は含めないでください。

次の例は、5 つのファイルを含むフォルダーの .order ファイルを示しています。

readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts

Wiki のホーム ページを設定する

Azure DevOps Web ポータルで Wiki を選択すると、Wiki のホーム ページが開きます。

既定では、Wiki の作成時に追加する最初のページは Wiki ホーム ページとして設定されます。 Wiki に複数のページがある場合、アルファベット順の最初のファイルがホーム ページとして設定されます。

Wiki ルートの .order ファイルでページ シーケンスを設定することで、ホーム ページとして使用するページを指定できます。 ルート .order ファイルの先頭行にホーム ページ名を配置します。

Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9

フォルダーを Wiki ページに昇格させる

リポジトリ内のフォルダーを Wiki のページとして表示できます。 このプロセスは、フォルダーをページに 昇格 させるプロセスと呼ばれます。

このシナリオでは、次の構成が必要です。

• フォルダーと同じ名前の Wiki の Markdown (.md) ファイル。

• Markdown ファイルとフォルダーは、Wiki のファイルリスト内の同じ場所に並んでいる必要があります。

次の例は、Test という名前のフォルダーと Markdown (.md) ファイルを示しています。 同じ場所に同じ名前の仲間がいることで、Wiki シーケンス内に同じ名前のページが作成されます。

Wiki バージョンを選択する

Wiki に複数の公開バージョンがある場合、最新バージョンが既定で表示されます。

ブランチ ドロップダウン リストを展開し、表示するバージョンを選択することで、別の Wiki バージョンを選択できます。

コード Wiki の発行を取り消す

Git リポジトリを Wiki として公開しなくなった場合は、Wiki の公開を解除できます。

1. Wiki リストで、非公開にする Wiki を選択し、[ その他のオプション (...)] を選択 >Wiki の発行を取り消す:

   

   [ 発行の取り消 し] アクションを選択すると、確認のためのダイアログが開きます。

2. 確認ダイアログで、[ 発行を取り消す] を選択します。

   

関連コンテンツ

• プロビジョニング済み Wiki と発行済み Wiki
• Wiki をオフラインで更新する
• Wiki Markdown のガイダンス