Wiki ページの追加と編集
- [アーティクル]
-
-
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
Wiki Git リポジトリがチーム プロジェクト用にプロビジョニングされた後、ページにタイトルとコンテンツを追加できます。 ページを編集してコンテンツをプレビューできるサイド バイ サイドの編集とプレビューエクスペリエンスがあります。
Markdown 形式を使用してページを作成するときに、書式設定ウィンドウを使用してリッチ テキストの書式設定を行い、画像、添付ファイル、リンクを挿入することもできます。
ページを編集するときに、 Ctrl + S キーを押して保存します。 カスタム リビジョン メッセージで保存するには、[保存] の横にある を選択します。 その他のショートカットについては、「 Wiki ページを管理するためのキーボード ショートカット」を参照してください。
Note
Git リポジトリから発行した Wiki にページを追加または編集するには、「Git リポジトリを Wiki に発行する」を参照してください。 この記事では、チーム プロジェクト用にプロビジョニングした Wiki のページを追加および編集する方法について説明します。
前提条件
- プロビジョニングされた wiki が必要です。
- Wiki ページを追加または更新するには、共同作成者としてチーム プロジェクトのメンバーである必要があります。
- プロジェクト Wiki を編集するには、基本アクセス レベルが必要です。
Wiki を開く
プロジェクトの Wiki ページを開いて表示できます。
コマンドを使用して、プロジェクトに対して定義された Wiki ページを表示および az devops wiki show
開くことができます。 開始するには、「 Azure DevOps CLI の概要」を参照してください。
az devops wiki show --wiki
[--open]
[--project]
[--subscription]
パラメーター
- --wiki: 必須。 Wiki の名前または ID。
- --open: 省略可能。 Web ブラウザーで Wiki ページを開きます。
- --project -p: 省略可能。 プロジェクトの名前または ID。
- --subscription: 省略可能。 サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
例
'myprojectwiki' という名前の Wiki を開きます。
az devops wiki show --wiki myprojectwiki --open
Wiki ページを表示する
Azure DevOps CLI を使用してページのコンテンツを取得するには、 コマンドを az devops wiki show
入力します。
az devops wiki page show --path
--wiki
[--include-content]
[--open]
[--project]
[--subscription]
[--version]
パラメーター
- --path: 必須。 Wiki ページのパス。
- --wiki: 必須。 Wiki の名前または ID。
- --include-content: 省略可能。 ページのコンテンツを含めます。
- --open: 省略可能。 Web ブラウザーで Wiki ページを開きます。
- --project -p: 省略可能。 プロジェクトの名前または ID。
- --version -v: 省略可能。 Wiki ページのバージョン (ETag)。
例
'myprojectwiki' という名前の Wiki のパス 'my wiki' を含む Wiki ページのコンテンツを取得します。
az devops wiki page show --path 'my wiki' --wiki 'myprojectwiki' --content "Hello World"
Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。
Wiki ページを追加する
別のページを追加するには、[ 新しいページ] を選択します。 または、サブページを追加するには、既存のページのコンテキスト メニューを開き、[ サブページの追加] を選択します。
235 文字以下の一意のタイトルを指定します。 ページ タイトルでは大文字と小文字が区別されます。 その他のタイトル制限については、「 Wiki Git リポジトリ ファイルとファイル構造」の「ファイルの名前付け規則」を参照してください。
キーボード ショートカットを使用して 、n キーを押して新しいページを追加したり、 c キーを押してサブページを追加したりすることもできます。 キーボード ショートカットの完全な一覧については、「 Wiki ページを管理するためのキーボード ショートカット」を参照してください。
Wiki ページを追加するには、 コマンドを az devops wiki page create
入力します。
az devops wiki page create --path
--wiki
[--comment]
[--content]
[--encoding {ascii, utf-16be, utf-16le, utf-8}]
[--file-path]
[--project]
[--subscription]
パラメーター
- --path: 必須。 Wiki ページのパス。
- --wiki: 必須。 Wiki の名前または ID。
- --comment: 省略可能。 ファイルの追加操作のコミット メッセージにコメントを付けます。 既定値: Azure DevOps CLI を使用して新しいページを追加しました。
- --content: 省略可能。 Wiki ページのコンテンツ。
--file-path
が指定されている場合は無視されます。
- --encoding: 省略可能。 ファイルのエンコード。 パラメーター
--file-path
使用します。
受け入れ可能な値: ascii
、 utf-16be
、 utf-16le
、 utf-8
- --file-path: 省略可能。 ファイルにコンテンツが指定されている場合のファイル入力のパス。
- --project -p: 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。プロジェクトの名前または ID。 az devops configure
-d project=NAME_OR_ID
を使用して、既定のプロジェクトを構成できます。
例
インライン コンテンツを含む 'myprojectwiki' という Wiki に、パス 'my page' を含む新しいページを作成します。
az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World"
Wiki のパス 'my page' を使用して、ファイルのコンテンツを含むページのコンテンツを更新します。
az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8
Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。
Wiki ページのタイトルの名前付けの制限
各 Wiki ページは、Wiki Git リポジトリ内のファイルに対応しています。 Wiki ページのタイトルに割り当てる名前は、次の制限に従う必要があります。
制限の種類 |
Restriction |
ファイル名 |
完全修飾ページ パスは、235 文字を超えてはなりません。 |
一意性 |
ページ タイトルは大文字と小文字が区別され、Wiki 階層内で一意である必要があります。 |
特殊文字 |
- Unicode 制御文字またはサロゲート文字を含めてはなりません。 - 次の印刷可能な文字を含めてはいけません: / \ # 。 - ピリオド . で開始または終了することはできません。 |
ファイル サイズ |
最大 18 MB を超えてはなりません。 |
添付ファイルのサイズ |
最大 19 MB を超えてはなりません。 |
Wiki ページ タイトルの特殊文字
これらの特殊文字の 1 つ以上を含むページ タイトルを : < > * ? | -
指定できます。 たとえば、Markdown ファイルに "FAQ" または "セットアップ ガイド" という名前を付けることができます。 文字には、次の URI でエンコードされた文字列があります。
文字 |
エンコードされた文字列 |
: |
%3A |
< |
%3C |
> |
%3E |
* |
%2A |
? |
%3F |
| |
%7C |
- |
%2D |
" |
%22 |
Wiki ページを編集および削除する
既存の Wiki ページを編集するには、ページを開いて [編集] を選択するか、コンテキスト メニューを開いて [編集] を選択します。 キーボード ショートカット e を使用して、現在のページの編集にすばやく移動することもできます。
コード Wiki の場合は、マークダウン ツール バーを使用してコンテンツを作成し、サイド バイ サイド エディターでページを編集できます。 このエクスペリエンスは、プロジェクト Wiki のプロセスと同じです。 Repos ハブの Wiki ページも、[リポジトリ で編集] オプションを使用して編集できます。
コード Wiki にブランチ ポリシーがある場合は、repos で 編集 を選択してブランチを作成し、編集を続けます。 [リポジトリの 編集 オプションは、コード Wiki で特に使用できます。
ページを削除するには、ツリーまたはページ内のコンテキスト メニューを開き、[削除] を選択 します。 開いたダイアログで削除を確認します。
Note
ページを削除すると、階層内のすべてのメタデータとそのすべてのサブページ (存在する場合) も削除されます。
Wiki ページを編集する
Wiki ページを編集するには、 コマンドを az devops wiki page update
入力します。
az devops wiki page update --path
--version
--wiki
[--comment]
[--content]
[--file-path]
[--project]
[--subscription]
パラメーター
- --path: 必須。 Wiki ページのパス。
- --version -v: 必須。 編集するファイルのバージョン (ETag)。
- --wiki: 必須。 Wiki の ID の名前。
- --comment: 省略可能。 削除操作のコミット メッセージにコメントを付けます。
- --file-path: 省略可能。 ファイルにコンテンツが指定されている場合のファイル入力のパス。
- --project -p: 省略可能。 プロジェクトの名前または ID。
- --subscription: 省略可能。 サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
例
インライン コンテンツを使用して、'myprojectwiki' という名前の Wiki のパス 'my page' でページのコンテンツを更新します。
az devops wiki page update --path 'my page' --wiki myprojectwiki --content "Hello World" --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b
Wiki のパス 'my page' を使用して、ファイルのコンテンツを含むページのコンテンツを更新します。
az devops wiki page update --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8 --version 4ae78ad5835cb7dd55072fe210c9ee7eb6d6413b
Wiki ページを削除する
Wiki ページを削除するには、 コマンドを az devops wiki page delete
入力します。
az devops wiki page delete --path
--wiki
[--comment]
[--project]
[--subscription]
[--yes]
パラメーター
- --path: 必須。 Wiki ページのパス。
- --wiki: 必須。 Wiki の名前または ID。
- --comment: 省略可能。 削除操作のコミット メッセージにコメントを付けます。
- --project -p: 省略可能。 プロジェクトの名前または ID。 az devops configure -d project=NAME_OR_ID を使用して、既定のプロジェクトを構成できます。 既定として構成されていない場合、または git 構成を使用して取得された場合は必須です。
- --subscription: 省略可能。 サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
- --yes -y: 省略可能。 確認を求めるプロンプトを表示しません。
例
'myprojectwiki' という名前の Wiki のパス 'my wiki' を含む Wiki ページを削除します。
az devops wiki page delete --path 'my wiki' --wiki 'myprojectwiki'
Azure DevOps CLI コマンドは、Azure DevOps Server ではサポートされていません。
Wiki ページを並べ替える
Wiki ツリー ビュー内のページを並べ替えて、目的の順序と階層にページを表示させることができます。 ツリー ビューでページ タイトルをドラッグ アンド ドロップすると、次の操作を実行できます。
- ページの親子関係を変更します。
- 階層内のページの順序を変更します。
Note
階層内のページを移動すると、他のページからのリンクが解除される可能性があります。 移動後は、いつでも手動でリンクを修正できます。 階層内のページの並べ替えは、ページ リンクには影響しません。
キーボード ショートカットを使用してページを並べ替えることもできます。 ページを選択し、 Ctrl + 上方向 キーまたは Ctrl + ↓ キーを押 してページの順序を変更します。
ページの親子関係を変更するには、そのコンテキスト メニューを開 き、[移動] を選択します。 [ ページの移動 ] ダイアログが開きます。 現在のページを移動できる親ページを選択します。
キーボード ショートカットの完全な一覧については、「 Wiki ページを管理するためのキーボード ショートカット」を参照してください。
Wiki ホーム ページにページを作成する
既定では、Wiki の作成時に追加する最初のページは Wiki ホーム ページとして設定されます。 ツリーの上部にページをドラッグ アンド ドロップすることで、別のページの関連性が高くなった場合は、Wiki ホームページを変更できます。
次のステップ
関連記事