Compartilhar via

New-MarkdownCommandHelp

Módulo:
Microsoft.PowerShell.PlatyPS Module

Cria arquivos de ajuda do Markdown para comandos e módulos do PowerShell.

Sintaxe

__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>]

Description

Cria arquivos de ajuda do Markdown para comandos e módulos do PowerShell.

Exemplos

Exemplo 1 – Criar arquivos de ajuda do Markdown para um módulo

$newMarkdownCommandHelpSplat = @{
    ModuleInfo = Get-Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Exemplo 2 – Criar arquivos de ajuda do Markdown a partir de uma lista de comandos

$newMarkdownCommandHelpSplat = @{
    CommandInfo = Get-Command -Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Parâmetros

-AbbreviateParameterTypename

Por padrão, esse comando usa nomes de tipo completos nos metadados de parâmetro e para os tipos de entrada e saída. Quando você usa esse parâmetro, o cmdlet gera nomes de tipo curtos.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CommandInfo

Uma lista de um ou mais comandos para os quais criar ajuda.

Propriedades do parâmetro

Tipo:

CommandInfo[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Encoding

A codificação usada ao criar os arquivos de saída. Se não for especificado, o cmdlet usará o valor especificado por $OutputEncoding.

Propriedades do parâmetro

Tipo:Encoding
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Por padrão, esse comando não substitui arquivos existentes. Quando você usa esse parâmetro, o cmdlet substitui os arquivos existentes.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HelpInfoUri

Esse parâmetro permite que você especifique o URI usado para ajuda atualizável. Por padrão, o cmdlet usa o HelpInfoUri especificado no manifesto do módulo.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HelpUri

Esse parâmetro permite que você especifique o URI usado para ajuda online. Por padrão, o cmdlet usa o URI definido no atributo [CmdletBinding()] para o comando.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HelpVersion

Esse parâmetro permite que você especifique a versão da ajuda. O valor padrão é 1.0.0.0. Esta versão é gravada no arquivo HelpInfo.xml usado para ajuda atualizável.

Propriedades do parâmetro

Tipo:Version
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Locale

Esse parâmetro permite que você especifique a localidade do idioma para os arquivos de ajuda. Por padrão, o cmdlet usa oCultureInfo atual. Use o cmdlet Get-Culture para ver as configurações de cultura atuais em seu sistema.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Metadata

Os metadados a serem adicionados ao frontmatter do arquivo markdown. Os metadados são um hashtable em que você especifica os pares chave e valor a serem adicionados ao frontmatter. Novos nomes de chave são adicionados ao frontmatter existente. Os valores das chaves existentes são substituídos. Não é possível substituir os valores das chaves document type ou PlatyPS schema version. Se essas chaves estiverem presentes no hashtable, o cmdlet ignorará os valores e gerará um aviso.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ModuleInfo

Uma lista de um ou mais módulos para o qual criar ajuda. O cmdlet cria arquivos de ajuda do Markdown para todos os comandos no módulo. O cmdlet cria uma pasta que corresponde ao nome do módulo no local de saída. Todos os arquivos markdown são gravados na pasta do módulo.

Propriedades do parâmetro

Tipo:

PSModuleInfo[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OutputFolder

Especifica o local de onde os arquivos de ajuda markdown são gravados. O cmdlet cria uma pasta para cada módulo que está sendo processado. Se o comando de destino não estiver associado a um módulo, o cmdlet criará um arquivo Markdown na raiz da pasta de saída.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo 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 do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WithModulePage

Por padrão, esse cmdlet cria apenas arquivos Markdown para comandos. Quando você usa esse parâmetro, o cmdlet cria um arquivo Markdown para o módulo. Esse arquivo Markdown contém uma lista de todos os comandos no módulo e metadados usados para criar o arquivo HelpInfo.xml.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo 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

CommandInfo

PSModuleInfo

Saídas

FileInfo