New-YamlHelp

Odwołanie

Moduł:: platyPS

Konwertuje pomoc języka Markdown na język YAML, aby można je było łatwo odczytać za pomocą narzędzi zewnętrznych

Składnia

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

Opis

Polecenie New-YamlHelp cmdlet działa podobnie do New-ExternalHelp polecenia cmdlet , ale zamiast tworzyć plik MAML do obsługi Get-Help, tworzy zestaw plików YAML, które mogą być odczytywane przez narzędzia zewnętrzne w celu zapewnienia niestandardowego renderowania stron pomocy.

Przykłady

Przykład 1. Tworzenie plików 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

Spowoduje to utworzenie jednego pliku YAML dla każdego polecenia cmdlet, aby narzędzia zewnętrzne mogły odczytywać dane ustrukturyzowane dla każdego polecenia cmdlet.

Przykład 2. Tworzenie plików YAML z określonym kodowaniem

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

Spowoduje to zarówno odczyt, jak i zapis plików w określonym -Encoding. Parametr Force zastąpi pliki, które już istnieją.

Parametry

-Encoding

Określa kodowanie znaków dla zewnętrznego pliku pomocy. Określ obiekt System.Text.Encoding . Aby uzyskać więcej informacji, zobacz about_Character_Encoding.

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

-Force

Wskazuje, że to polecenie cmdlet zastępuje istniejący plik o tej samej nazwie.

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

-OutputFolder

Określa folder do utworzenia plików YAML w folderze

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

-Path

Określa tablicę ścieżek plików lub folderów markdown. To polecenie cmdlet tworzy pomoc zewnętrzną na podstawie tych plików i folderów.

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

Dane wejściowe

String[]

Do tego polecenia cmdlet można przekazać tablicę ścieżek.

Dane wyjściowe

FileInfo[]

To polecenie cmdlet zwraca FileInfo[] obiekt dla utworzonych plików.

Udostępnij za pośrednictwem