Update-MarkdownCommandHelp
Atualiza um arquivo de comando Markdown importado com as informações do cmdlet session de mesmo nome.
Sintaxe
Path (Padrão)
Update-MarkdownCommandHelp
[-Path] <string[]>
[-NoBackup]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Update-MarkdownCommandHelp
-LiteralPath <string[]>
[-NoBackup]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Descrição
Este cmdlet importa um objeto CommandHelp de um arquivo Markdown e atualiza o objeto com as informações do cmdlet de sessão de mesmo nome e, em seguida, reescreve o arquivo Markdown com as informações atualizadas.
Exemplos
Exemplo 1
$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Update-MarkdownCommandHelp -Path {$_.FilePath}
Parâmetros
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Suporta curingas: | False |
| DontShow: | False |
| Pseudónimos: | Cf. |
Conjuntos de parâmetros
(All)
| Posição: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-LiteralPath
Especifica um caminho para um ou mais arquivos de comando markdown. O valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como carta curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples indicam ao PowerShell para não interpretar quaisquer caracteres como sequências de escape.
Para obter mais informações, consulte about_Quoting_Rules.
Propriedades dos parâmetros
| Tipo: | String[] |
| Valor padrão: | None |
| Suporta curingas: | False |
| DontShow: | False |
| Pseudónimos: | PSPath, LP |
Conjuntos de parâmetros
LiteralPath
| Posição: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-NoBackup
Por padrão, o cmdlet cria um backup do arquivo Markdown original antes de atualizá-lo. Use esse parâmetro para suprimir a criação do arquivo de backup.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Suporta curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Posição: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-PassThru
Por padrão, esse cmdlet não gera nenhuma saída. Use esse parâmetro para retornar o objeto de arquivo atualizado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Suporta curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Posição: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Path
Especifica o caminho para um ou mais arquivos de comando Markdown. Caracteres coringa são permitidos.
Propriedades dos parâmetros
| Tipo: | String[] |
| Valor padrão: | None |
| Suporta curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
Path
| Posição: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-WhatIf
Executa o comando em um modo que relata apenas o que aconteceria sem executar as ações.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Suporta curingas: | False |
| DontShow: | False |
| Pseudónimos: | Wi |
Conjuntos de parâmetros
(All)
| Posição: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
String
Saídas
FileInfo
Notas
Esse comando é semelhante ao cmdlet Update-CommandHelp, mas atualiza o arquivo Markdown de origem.