New-MarkdownCommandHelp
PowerShell モジュールとコマンドの Markdown ヘルプ ファイルを作成します。
構文
__AllParameterSets
New-MarkdownCommandHelp
-OutputFolder <string>
[-CommandInfo <CommandInfo[]>]
[-Encoding <Encoding>]
[-Force]
[-HelpUri <string>]
[-HelpInfoUri <string>]
[-HelpVersion <version>]
[-Locale <string>]
[-Metadata <hashtable>]
[-ModuleInfo <psmoduleinfo[]>]
[-WithModulePage]
[-AbbreviateParameterTypename]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
PowerShell モジュールとコマンドの Markdown ヘルプ ファイルを作成します。
例
例 1 - モジュールの Markdown ヘルプ ファイルを作成する
$newMarkdownCommandHelpSplat = @{
ModuleInfo = Get-Module Microsoft.PowerShell.PlatyPS
OutputFolder = '.'
HelpVersion = '1.0.0.0'
WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat
例 2 - コマンドの一覧から Markdown ヘルプ ファイルを作成する
$newMarkdownCommandHelpSplat = @{
CommandInfo = Get-Command -Module Microsoft.PowerShell.PlatyPS
OutputFolder = '.'
HelpVersion = '1.0.0.0'
WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat
パラメーター
-AbbreviateParameterTypename
既定では、このコマンドでは、パラメーター メタデータと入力と出力の型に完全な型名が使用されます。 このパラメーターを使用すると、コマンドレットは短い型名を出力します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CommandInfo
ヘルプを作成する 1 つ以上のコマンドの一覧。
パラメーターのプロパティ
| 型: | CommandInfo[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Encoding
出力ファイルの作成時に使用されるエンコード。 指定しない場合、コマンドレットは $OutputEncodingで指定された値を使用します。
パラメーターのプロパティ
| 型: | Encoding
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
既定では、このコマンドは既存のファイルを上書きしません。 このパラメーターを使用すると、コマンドレットによって既存のファイルが上書きされます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-HelpInfoUri
このパラメーターを使用すると、更新可能なヘルプに使用される URI を指定できます。 既定では、コマンドレットはモジュール マニフェストで指定された HelpInfoUri を使用します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-HelpUri
このパラメーターを使用すると、オンライン ヘルプに使用する URI を指定できます。 既定では、コマンドレットはコマンドの [CmdletBinding()] 属性で定義されている URI を使用します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-HelpVersion
このパラメーターを使用すると、ヘルプのバージョンを指定できます。 既定値は 1.0.0.0 です。 このバージョンは、更新可能なヘルプに使用される HelpInfo.xml ファイルに書き込まれます。
パラメーターのプロパティ
| 型: | Version
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Locale
このパラメーターを使用すると、ヘルプ ファイルの言語ロケールを指定できます。 既定では、コマンドレットは現在の CultureInfoを使用します。
Get-Culture コマンドレットを使用して、システムの現在のカルチャ設定を確認します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
マークダウン ファイルのフロントマッターに追加するメタデータ。 メタデータはハッシュテーブルであり、フロントマッターに追加するキーと値のペアを指定します。 新しいキー名が既存のフロントマッターに追加されます。 既存のキーの値が上書きされます。
document type キーまたは PlatyPS schema version キーの値を上書きすることはできません。 これらのキーがハッシュテーブルに存在する場合、コマンドレットは値を無視し、警告を出力します。
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ModuleInfo
ヘルプを作成する 1 つ以上のモジュールの一覧。 コマンドレットは、モジュール内のすべてのコマンドの Markdown ヘルプ ファイルを作成します。 コマンドレットは、出力場所にモジュールの名前と一致するフォルダーを作成します。 すべての Markdown ファイルはモジュール フォルダーに書き込まれます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-OutputFolder
Markdown ヘルプ ファイルが書き込まれる場所を指定します。 このコマンドレットは、処理されるモジュールごとにフォルダーを作成します。 ターゲット コマンドがモジュールに関連付けられていない場合、コマンドレットは出力フォルダーのルートに Markdown ファイルを作成します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
アクションを実行せずに何が起こるかのみを報告するモードでコマンドを実行します。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WithModulePage
既定では、このコマンドレットはコマンド用の Markdown ファイルのみを作成します。 このパラメーターを使用すると、コマンドレットによってモジュールの Markdown ファイルが作成されます。 この Markdown ファイルには、モジュール内のすべてのコマンドの一覧と、HelpInfo.xml ファイルの作成に使用されるメタデータが含まれています。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力