New-YamlHelp

Ссылка

Модуль:: platyPS

Преобразует справку Markdown в YAML для удобства чтения внешними средствами.

Синтаксис

New-YamlHelp
   [-Path] <String[]>
   -OutputFolder <String>
   [-Encoding <Encoding>]
   [-Force]
   [<CommonParameters>]

Описание

Командлет New-YamlHelp работает аналогично командлету New-ExternalHelp , но вместо создания ФАЙЛА MAML для поддержки Get-Helpон создает набор файлов YAML, которые могут быть считаны внешними инструментами для предоставления пользовательской отрисовки страниц справки.

Примеры

Пример 1. Создание файлов YAML

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

При этом создается один ФАЙЛ YAML для каждого командлета, чтобы внешние средства могли считывать структурированные данные для каждого командлета.

Пример 2. Создание YAML-файлов с определенной кодировкой

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml -Force -Encoding ([System.Text.Encoding]::Unicode)

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

При этом будут считываться и записываться файлы в указанной кодировке -Encoding. Параметр Force перезапишет уже существующие файлы.

Параметры

-Encoding

Задает кодировку символов для внешнего файла справки. Укажите объект System.Text.Encoding . Подробные сведения см. в статье О шифровании символов.

Type:	Encoding
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputFolder

Указывает папку для создания файлов YAML в

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Задает массив путей к файлам или папкам Markdown. Этот командлет создает внешнюю справку на основе этих файлов и папок.

Type:	String[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

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

String[]

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

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

FileInfo[]

Этот командлет возвращает FileInfo[] объект для созданных файлов.

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