Get-MarkdownMetadata

Ссылка

Модуль:: platyPS

Возвращает метаданные из заголовка файла Markdown.

Синтаксис

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

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

Описание

Командлет Get-MarkdownMetadata получает метаданные из заголовка файла Markdown, поддерживаемого PlatyPS. Команда возвращает метаданные в виде хэш-таблицы.

PlatyPS сохраняет метаданные в блоке заголовков файла Markdown в виде пар строк с ключом-значением. По умолчанию PlatyPS хранит имя файла и версию схемы Markdown.

Раздел метаданных может содержать предоставленные пользователем значения для использования с внешними инструментами. Командлет New-ExternalHelp игнорирует эти метаданные.

Примеры

Пример 1. Получение метаданных из файла

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

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

Эта команда извлекает метаданные из файла Markdown.

Пример 2. Получение метаданных из строки Markdown

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

Первая команда получает содержимое файла и сохраняет их в переменной $Markdown.

Вторая команда извлекает метаданные из строки в $Metadata.

Пример 3. Получение метаданных из всех файлов в папке

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

Эта команда получает метаданные из каждого файла markdown в папке .\docs.

Параметры

-Markdown

Указывает строку, содержащую отформатированный текст markdown.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Path

Задает массив путей файлов или папок Markdown.

Тип:	String[]
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	True

Входные данные

String[]

Вы можете передать массив путей к этому командлету.

Выходные данные

Dictionary[String, String]

Командлет возвращает объект Dictionary[String, String]. Словарь содержит пары "ключ-значение", найденные в блоке метаданных Markdown.

Поделиться через