Import-MarkdownModuleFile
Importa um arquivo de módulo Markdown para um objeto ModuleHelp.
Sintaxe
Path (Padrão)
Import-MarkdownModuleFile
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MarkdownModuleFile
-LiteralPath <string[]>
[<CommonParameters>]
Descrição
O comando importa arquivos Markdown contendo a ajuda do módulo e cria objetos ModuleHelp. O objeto ModuleHelp é uma representação estruturada do conteúdo da ajuda que pode ser usado para exportar para diferentes formatos.
Exemplos
Exemplo 1 - Converter
Import-MarkdownModuleFile .\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
Metadata : {[document type, module], [HelpInfoUri, ], [Locale, en-US], [Module Guid,
0bdcabef-a4b7-4a6d-bf7e-d879817ebbff]…}
Title : Microsoft.PowerShell.PlatyPS Module
Module : Microsoft.PowerShell.PlatyPS
ModuleGuid : 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff
Description : This module contains cmdlets to help with the creation help content for PowerShell commands.
Locale : en-US
CommandGroups : {Microsoft.PowerShell.PlatyPS.ModuleCommandGroup}
Diagnostics : Microsoft.PowerShell.PlatyPS.Model.Diagnostics
Parâmetros
-LiteralPath
Especifica um caminho para um ou mais locais que contêm arquivos de marcação. 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 |
-Path
Especifica o caminho para um item. Este cmdlet obtém o item no local especificado. Caracteres coringa são permitidos. Este parâmetro é necessário, mas o nome do parâmetro Path é opcional.
Use um ponto (.) para especificar o local atual. Use o caractere curinga (*) para especificar todos os itens no local atual.
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 |
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.