Get-MarkdownMetadata

Referência

Módulo:: platyPS

Obtém metadados do cabeçalho de um arquivo de marcação.

Sintaxe

Get-MarkdownMetadata
   -Path <String[]>
   [<CommonParameters>]

Get-MarkdownMetadata
   -Markdown <String>
   [<CommonParameters>]

Description

O cmdlet Get-MarkdownMetadata obtém os metadados do cabeçalho de um arquivo de markdown suportado pelo PlatyPS. O comando retorna os metadados como uma tabela de hash.

PlatyPS armazena metadados no bloco de cabeçalho de um arquivo de marcação como pares chave-valor de cadeias de caracteres. Por padrão, o PlatyPS armazena o nome do arquivo de ajuda e a versão do esquema de marcação.

A seção de metadados pode conter valores fornecidos pelo usuário para uso com ferramentas externas. O cmdlet New-ExternalHelp ignora esses metadados.

Exemplos

Exemplo 1: Obter metadados de um ficheiro

PS C:\> Get-MarkdownMetadata -Path ".\docs\Get-MarkdownMetadata.md"

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0

Este comando recupera metadados de um arquivo de marcação.

Exemplo 2: Obter metadados de uma cadeia de caracteres de marcação

PS C:\> $Markdown = Get-Content -Path ".\docs\Get-MarkdownMetadata.md" -Raw
PS C:\> Get-MarkdownMetadata -Markdown $Markdown

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0

O primeiro comando obtém o conteúdo de um arquivo e os armazena na variável $Markdown.

O segundo comando recupera metadados da cadeia de caracteres no $Metadata.

Exemplo 3: Obter metadados de todos os arquivos em uma pasta

PS C:\> Get-MarkdownMetadata -Path ".\docs"

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0

Este comando obtém metadados de cada um dos arquivos de marcação na pasta .\docs.

Parâmetros

-Markdown

Especifica uma cadeia de caracteres que contém texto formatado com marcação.

Tipo:	String
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	False
Aceitar carateres universais:	False

-Path

Especifica uma matriz de caminhos de arquivos ou pastas de marcação.

Tipo:	String[]
Position:	Named
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	True

Entradas

String[]

Você pode canalizar uma matriz de caminhos para esse cmdlet.

Saídas

Dictionary[String, String]

O cmdlet retorna um objeto Dictionary[String, String]. O dicionário contém pares chave-valor encontrados no bloco de metadados de markdown.

Partilhar via