Partilhar via

Export-MarkdownCommandHelp

Módulo:
Microsoft.PowerShell.PlatyPS Module

Exporta um objeto CommandHelp para um arquivo de marcação.

Sintaxe

__AllParameterSets 

Export-MarkdownCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-OutputFolder <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrição

Este comando exporta um objeto CommandHelp para um arquivo de markdown. Você pode adicionar frontmatter de metadados ao arquivo de markdown usando o parâmetro Metadata. Você pode obter um objeto CommandHelp usando o cmdlet Export-MarkdownCommandHelp ou um dos cmdlets Import-*.

Exemplos

Exemplo 1 - Converter conteúdo de ajuda antigo do Markdown para o novo formato

Este exemplo importa a ajuda Markdown no formato antigo da pasta .\v1 e a exporta para a pasta .\v2 no novo formato.

$chobj = Import-MarkdownCommandHelp -Path .\v1\Export-YamlModuleFile.md
Export-MarkdownCommandHelp -CommandHelp $chobj -OutputFolder .\v2

    Directory: D:\Git\PS-Src\platyPS\v2docs\v2

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           5/20/2024  3:33 PM           2892 Export-YamlModuleFile.md

Exemplo 2 - Converter uma pasta de conteúdo de ajuda do Markdown antigo para o novo formato

Este exemplo importa a ajuda Markdown no formato antigo da pasta .\v1 e a exporta para a pasta .\v1\new no novo formato. Se necessário, Export-MarkdownCommandHelp cria as pastas de destino. Os novos arquivos de markdown são gravados na pasta nomeada para o módulo ao qual pertencem.

$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Export-MarkdownCommandHelp -OutputFolder .\v1\new

    Directory: D:\Git\PS-Src\platyPS\v2docs\v1\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:30 PM           3194 Compare-CommandHelp.md
-a---           8/26/2024  3:30 PM           4282 Export-MamlCommandHelp.md
-a---           8/26/2024  3:30 PM           6401 Export-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           4874 Export-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           6429 Export-YamlCommandHelp.md
-a---           8/26/2024  3:30 PM           5601 Export-YamlModuleFile.md
-a---           8/26/2024  3:30 PM           2724 Import-MamlHelp.md
-a---           8/26/2024  3:30 PM           3733 Import-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           3870 Import-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           3907 Import-YamlCommandHelp.md
-a---           8/26/2024  3:30 PM           3477 Import-YamlModuleFile.md
-a---           8/26/2024  3:30 PM           2088 Measure-PlatyPSMarkdown.md
-a---           8/26/2024  3:30 PM           4748 New-CommandHelp.md
-a---           8/26/2024  3:30 PM           8647 New-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           5086 New-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           3080 Test-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           3041 Update-CommandHelp.md
-a---           8/26/2024  3:30 PM           3981 Update-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           5548 Update-MarkdownModuleFile.md

Parâmetros

-CommandHelp

O CommandHelp objeto a ser exportado. Você pode passar o objeto CommandHelp no pipeline ou usando o parâmetro Command.

Propriedades dos parâmetros

Tipo:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-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

-Encoding

A codificação a ser usada ao gravar o arquivo de markdown. Se nenhum valor for especificado, a codificação será padronizada para o valor da variável de preferência $OutputEncoding.

Propriedades dos parâmetros

Tipo:Encoding
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

-Force

Use o parâmetro Force para substituir o arquivo de saída, se ele já existir.

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

-Metadata

Os metadados a serem adicionados ao frontmatter do arquivo de markdown. Os metadados são uma hashtable onde você especifica os pares de chave e valor para adicionar ao frontmatter. Novos nomes de chave são adicionados ao frontmatter existente. Os valores das chaves existentes são substituídos.

Propriedades dos parâmetros

Tipo:Hashtable
Valor padrão:None
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

-OutputFolder

A pasta onde o arquivo de marcação é salvo. Se a pasta não existir, ela será criada.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
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

-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

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Saídas

FileInfo