Azure DevOps Services |Azure DevOps Server 2022 および Azure DevOps Server 2019
チーム プロジェクトの Wiki Git リポジトリ を設定したら、Wiki とページ コンテンツのタイトルを追加できます。 Azure DevOps UI では、ページを編集したり、作業中に変更をプレビューしたりできるサイド バイ サイド エクスペリエンスが提供されます。
[編集] ウィンドウでは、Markdown 形式の構文を使用してページコンテンツを入力します。 画像、添付ファイル、リンクを挿入することもできます。 変更すると、[ プレビュー ] ウィンドウでコンテンツが更新されます。 見出し、リスト、リンク、画像などの特別な書式を持つコンテンツは、[ プレビュー ] ウィンドウにリッチ テキストとして表示されます。
ページを編集するときに、 Ctrl + S キーボード ショートカットを使用して作業をすばやく保存します。 また、"ページ リンクの追加" などのカスタム リビジョン メッセージを使用して作業内容を保存することもできます。このオプションは、[保存] ドロップダウン メニューで使用できます。
その他のキーボード ショートカットも利用できます。 詳細については、「 Wiki ページを管理するためのキーボード ショートカット」を参照してください。
注
この記事では、チーム プロジェクト用に作成された Wiki でページを追加および編集する方法について説明します。 Git リポジトリから発行された Wiki にページを追加または編集する場合は、「Git リポジトリを Wiki に発行する」を参照してください。
Wiki コマンド ライン ツール
Azure DevOps CLI コマンドを使用して、Wiki コンテンツを管理できます。 次の表に、特定のコマンドの使用方法を説明するこの記事のセクションへのリンクを示します。
コマンド | 説明 |
---|---|
az devops wiki show | Wiki を開き、Wiki のホーム ページを表示します。 |
az devops wiki ページを表示 | Wiki で特定のページを表示します。 |
az devops wiki page create | Wiki に新しいページを追加します。 |
az devops wiki ページの更新 | Wiki で既存のページを編集します。 |
az devops wiki ページの削除 | Wiki でページを削除します。 |
前提条件
カテゴリ | 要求事項 |
---|---|
プロジェクトへのアクセス | Wiki が配置されているプロジェクトのメンバー。 必要に応じて、プロジェクト管理者にアクセス権を要求できます。 |
アクセス許可 | 共同作成者 グループのメンバー。 |
アクセス レベル | 少なくとも Basic アクセス。 |
タスク | プロジェクト用に プロビジョニングされた Wiki を準備します。 |
Wiki を開く
ブラウザーで Azure DevOps からチーム プロジェクトの Wiki ページを開いて表示したり、Azure DevOps CLI を使用したりできます。
サポートされている Web ブラウザーを使用してプロジェクトに接続し、Wiki を選択します。
チーム プロジェクトを切り替える必要がある場合は、 Azure DevOps を選択して 、すべてのチーム プロジェクトとチームを参照します。
Wiki ページを追加する
このセクションでは、Wiki にページを追加する方法について説明します。 ブラウザーで Azure DevOps UI を直接操作することも、Azure DevOps CLI を使用することもできます。
Wiki に新しいページを追加するには、2 つのオプションがあります。 まず、ホーム ページなど、リスト内のページを選択します。
現在のページと同じレベルでページを追加するには、Azure DevOps UI の下部にある [新しいページ ] を選択します。
現在のページにサブページを追加するには、 その他のオプション (...) を選択 >サブページを追加します。
キーボード ショートカットを使用してページを追加することもできます。 現在のページを選択し、 n を選択して新しいページを追加するか、 c を選択してサブページを追加します。 詳細については、「 Wiki ページを管理するためのキーボード ショートカット」を参照してください。
ページ タイトルとファイル名
ページの一意のタイトルを入力します。 値では大文字と小文字が区別されます。 タイトルは、ページのファイル名として使用されます。 ファイル名では、ページ タイトルのスペースはハイフン (-
) に置き換えられます。 たとえば、"投稿方法" というページ タイトルは、 How-to-contribute.md ファイル名に対応します。 ファイルの完全修飾パスは 235 文字以下にする必要があります。
その他のファイル名の制限については、 Wiki Git リポジトリのファイルとファイル構造、ファイルの名前付け規則に関するページを参照してください。
ページ タイトルとファイル名の制限
各 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 という名前を付けることができます。
Von Bedeutung
ページ構文とブラウザー ナビゲーションでエラーが発生しないようにするには、ページ ファイル名にスペース文字 (
) を使用しないでください。 ページ タイトルに基づいてページ ファイルに名前を付け、ページ タイトル内のスペースをファイル名にハイフン (-
) で置き換えます。
次の表に、Wiki ページ ファイル名で使用できる特殊文字と、対応する URI でエンコードされた文字列を示します。
文字 | 記号 | URI 文字列 |
---|---|---|
コロン | : |
%3A |
左不等号 | < |
%3C |
右山括弧 | > |
%3E |
アスタリスク (ワイルドカード) | * |
%2A |
疑問符 | ? |
%3F |
パイプ | | |
%7C |
ハイフン (ダッシュ) | - |
%2D |
二重引用符 | " |
%22 |
たとえば、ファイル名 FAQ:0525 は FAQ%3A0525
としてエンコードされます。
Wiki のホーム ページを設定する
既定では、Wiki の作成時に追加する最初のページは Wiki ホーム ページとして設定されます。 別のページの関連性が高くなった場合は、Wiki のホームページを変更できます。 詳細については、「 Wiki ページの並べ替えまたは移動」を参照してください。
Wiki ページを編集および削除する
このセクションでは、Wiki でページを編集または削除する方法について説明します。 ブラウザーで Azure DevOps UI を直接操作することも、Azure DevOps CLI を使用することもできます。
ブラウザーで既存の Wiki ページを編集するには、いくつかの方法があります。
- Wiki ページを開き、[ 編集] を選択します。
- Wiki ページを開き、キーボード ショートカットを使用 します。
- ページ一覧で Wiki ページを選択し、[その他のオプション (...)] を選択>編集。
特定の編集機能の詳細については、「Markdown ガイダンスを使用する」を参照してください。
コード Wiki のリポジトリで編集する
コードを Wiki として発行すると、 Repos ハブで Wiki ページを編集できます。 Markdown ツール バーの書式設定オプションでは、同じサイド バイ サイド エディター エクスペリエンスを使用できます。 [ 編集]>[リポジトリの編集 ] を選択してブランチを作成し、編集を続けます。
[ リポジトリで編集] オプションは、ブランチ ポリシーが有効になっているコード Wiki でのみ使用できます。 このオプションが表示されない場合は、Wiki がコード Wiki ではないか、ブランチ ポリシーが有効になっていない可能性があります。 詳細については、ブランチのポリシーと設定に関する記事を参照してください。
ブラウザーで Wiki ページを削除する
Wiki ページを削除するには、ページ一覧で Wiki ページを選択し、[ その他のオプション (...)] を選択 >削除します。 ページの右クリック メニューから [ 削除 ] を選択することもできます。
[ 削除] を選択した後、ダイアログで削除を確認します。
注
Wiki ページを削除すると、ページのすべてのメタデータと、ページにアタッチされているすべてのサブページも削除されます。
Wiki ページの並べ替えまたは移動
ブラウザーでは、Wiki ツリー ビューのページを並べ替えて、ページが好みの順序で表示されるようにすることができます。 既定のシーケンスは、ファイル名のアルファベット順です。 順序を変更して、記事、カテゴリ、または対象ユーザーごとにページを並べ替えることができます。
ツリー ビューのページ タイトルでドラッグ アンド ドロップ アクションを使用すると、次のタスクを実行できます。
移動: ページのページ/サブページの関係を変更します。 Wiki シーケンス内でページを移動すると、他の Wiki ページからのページへのリンクが壊れる可能性があります。 これらのリンクは、ページの移動後に手動で 修正 できます。
並べ替え: Wiki シーケンス内のページの順序を変更します。 Wiki シーケンス内のページの順序を変更しても、ページ リンクには影響しません。
ページの移動後に壊れたリンクを修正する
Wiki シーケンス内のページを移動した後に壊れたリンクを修正するには、次の手順に従います。
Wiki の他のページをテストし、移動したページへのリンクを探します。
ページ上のエラー メッセージ、またはコンテンツが見つからないかどうかを確認します。
リンクが壊れているページを開き、[ 編集] を選択して、ページ コンテンツの壊れたリンクに移動します。
コンテンツ内の壊れたリンクを見つけるには、移動したページの名前、移動したページの元のファイル パス、または破損したリンクのリンク テキストを検索できます。
壊れたリンクを更新します。 一般的な修正は、移動されたページの新しい場所をターゲットにするようにリンク内の URL またはパスを変更する方法です。
リンクが更新されるように変更をページに保存します。
ブラウザーで更新されたページを開き、リンクをテストします。 移動したページが正常に開くことを確認します。
最上位ページの順序を変更する
キーボード ショートカットを使用して、Wiki シーケンスの最上位ページを並べ替えることができます。 このアクションは、サブページでは機能しません。
Wiki ページの一覧でページを選択し、 Ctrl + ↑ または Ctrl + ↓ ショートカットを使用して、シーケンス内でページを移動します。 変更はすぐに適用されます。
ページ/サブページの順序を変更する
Wiki シーケンス内の任意のページのページ/サブページの順序を変更することもできます。
Wiki ページの一覧で移動するページを選択します。
その 他のオプション (...) を選択 >[移動] をクリックすると、[ ページの移動 ] ダイアログが開きます。
[ ページの移動 ] ダイアログで、新しい 親 ページとして機能するページを選択します。
新しい親ページを選択すると、ページ移動に基づいて壊れている可能性のあるリンクがスキャンされます。 調整が必要なリンクが報告されます。
[ ページと作業項目の影響を受けるリンクを更新する (推奨)] オプションを選択し、[ 移動 ] を選択してページ移動を完了します。
キーボード ショートカットの完全な一覧については、「 Wiki ページを管理するためのキーボード ショートカット」を参照してください。