Compartilhar via

New-MarkdownModuleFile

Módulo:
Microsoft.PowerShell.PlatyPS Module

Cria o arquivo de módulo Markdown para um módulo do PowerShell.

Sintaxe

__AllParameterSets 

New-MarkdownModuleFile
    -OutputFolder <string>
    [-CommandHelp <CommandHelp[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Esse comando cria o arquivo de módulo Markdown para um módulo do PowerShell. O arquivo de módulo contém os metadados do módulo e uma lista de todos os comandos com suas descrições de sinopse. Esse arquivo pode ser usado como a página de aterrissagem do módulo em um conjunto de documentação. Os metadados do módulo são usados por Export-MamlCommandHelp para criar o arquivo de ajuda MAML para o módulo.

Exemplos

Exemplo 1 – Criar um novo arquivo de módulo de uma pasta de arquivos de ajuda de comando

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

    Directory: D:\Docs\v2\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

Exemplo 2 – Criar um novo arquivo de módulo a partir de uma lista de comandos

$newMarkdownCommandHelpSplat = @{
    CommandHelp  = Get-Command -Module Microsoft.PowerShell.PlatyPS | New-CommandHelp
    OutputFolder = '.\new'
    Force        = $true
}
New-MarkdownModuleFile @newMarkdownCommandHelpSplat

    Directory: D:\Docs\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

Parâmetros

-CommandHelp

O CommandHelp objetos a serem incluídos no arquivo de módulo. Você pode passar o objeto CommandHelp no pipeline ou usando o parâmetro comando .

Propriedades do parâmetro

Tipo:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

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

-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

-OutputFolder

Especifica o local de onde o arquivo de módulo Markdown é gravado. O cmdlet cria uma pasta para cada módulo com base no objeto CommandHelp que está sendo processado.

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

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