Git の Wiki ファイルとフォルダー構造

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

これに対して、プロビジョニングされた Wiki とコードとして発行された Wiki のファイルとフォルダー構造について説明します。 どちらの種類の Wiki でも、ファイルは Git リポジトリに格納されます。 ファイルには、Markdown ページ、コード、画像、添付ファイル、またはその他の成果物を含めることができます。 ファイルのプレゼンテーション シーケンスを確立するために、Git は各リポジトリ フォルダーに特別なファイル (.order) を追加します。

プロジェクトを作成すると、既定では Wiki は作成されません。 Wiki をプロビジョニングしたり、README を作成したり、プロジェクト コードを wiki として発行したりできます。

Wiki は、Azure DevOps ユーザー インターフェイスを使用して作成します。 その後、 Git リポジトリの URL パスから Wiki を編集できます。

リポジトリ ファイルとフォルダー構造

Wiki の Git リポジトリには、次の 2 つの名前付け規則があります。

• wiki リポジトリ名は<ProjectName>.wikiで、<ProjectName>はあなたのプロジェクトの名前です。
• wiki リポジトリのルート ブランチの名前は wikiMain。

wikiMain ブランチでブランチ ポリシーを定義することで、他の Git リポジトリを管理するのと同じ方法で Wiki リポジトリを管理します。 また、ローカル wikiMain ブランチに変更を加え、ポリシーを定義せずにリモート ブランチに直接プッシュすることもできます。

Wiki リポジトリは、次のファイルとフォルダーで構成されます。

• ルート レベルにある各 Markdown ページのファイル
• ルート レベルおよび各サブフォルダー内にある .order という名前のファイル
• サブページを含む各 Wiki ページのサブフォルダー
• Wiki で使用されるすべての添付ファイルを格納するための .attachments という名前のフォルダー

ファイルの名前付け規則

各 Wiki ページのファイル名は、Wiki ページのタイトルに対応します。 ファイル名では、ハイフン (-) はページ タイトル内のスペースを表します。 たとえば、"投稿方法" というページ タイトルは、 How-to-contribute.md ファイル名に対応します。 Wiki ページの URL パスには、ファイル名が含まれています。 たとえば、https://github.com/ExampleWiki/How-To/How-to-contribute.md のようにします。 この方法は、Wiki が時間の経過と同時に変化しても、ページへのブックマーク リンクがそのまま維持されるようにするのに役立ちます。

各 Wiki ページは、Wiki Git リポジトリ内のファイルに対応しています。 ページ ファイル名とファイル サイズには、次の制限が適用されます。

• ファイル名: ページ ファイルの名前を選択するときは、ファイルの完全修飾パスが 235 文字以下である必要があることに注意してください。 ページへの完全なパスは、リポジトリ URL、ページ ファイルへのフォルダー パス、およびページ ファイル名で構成されます。 たとえば、https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md のようにします。

• 一意性: ページ ファイル名は、Wiki リポジトリ階層内のフォルダーの場所内で一意である必要があります。 名前では大文字と小文字が区別されます。

• 特殊文字: ページ ファイル名には、次の特殊文字に関する制限があります。

  • Unicode 制御文字またはサロゲート文字なし
  • 印刷できない文字: スラッシュ /、バックスラッシュ \、ハッシュ #
  • 名前の先頭または末尾にピリオド . 記号がありません

• ファイル サイズ: ページ ファイルの最大サイズは 18 MB です。

• 添付ファイルのサイズ: ページ ファイルへの添付ファイルの最大サイズは 19 MB です。

使用できる特殊文字

ページ ファイル名には、コロン : やハイフン -など、いくつかの特殊文字を使用できます。 たとえば、マークダウン ファイルに FAQ:0525 または Setup-Guide という名前を付けることができます。

次の表に、Wiki ページ ファイル名で使用できる特殊文字と、対応する URI でエンコードされた文字列を示します。

たとえば、ファイル名 FAQ:0525 は FAQ%3A0525としてエンコードされます。

ページ シーケンスと .order ファイル

.order ファイルは Wiki ページ シーケンスを定義します。 Git は各フォルダーでこのファイルを検索し、その場所にファイルを表示するシーケンスを識別します。 既定のページ シーケンスは、ファイル名のアルファベット順 (A から Z) です。

カスタム ページ シーケンスを定義する

フォルダーに .order ファイルがない場合、Git では既定のアルファベット順が使用されます。

ルート レベルを含め、フォルダー内の .order ファイルを更新することで、任意のフォルダーのカスタム シーケンスを定義できます。

次のビジュアルは、Wiki 目次 (TOC) と、TOC を作成する対応する .order ファイルの例を示しています。

.order ファイルでは、シーケンスがアルファベット順から "Marketing" に変更され、その後に "Fabrikam Fiber" が続きます。

Wiki ページの順序を変更する方法の詳細については、「Wiki ページの 追加、編集、並べ替え」を参照してください。

アルファベット順の復元

フォルダーにカスタム シーケンスがある場合は、次の手順に従って並べ替え方法をアルファベット順に戻すことができます。

1. Wiki の複製 URL をコピーし、ブラウザーで開きます。 Wiki の Git リポジトリが開きます。

2. 対象の .order ファイルに移動し、そのファイルを削除します。 ファイルが削除されると、Git はその場所の新しい .order ファイルを自動的に作成します。 新しいファイルでは、既定のシーケンスが使用されます。

関連コンテンツ

• Wiki を設定する方法と、コードを wiki として発行する方法
• チーム プロジェクトの Wiki を作成する
• Git リポジトリを Wiki に公開する