Export-MarkdownCommandHelp

Moduł:

Microsoft.PowerShell.PlatyPS Module

Eksportuje obiekt CommandHelp do pliku markdown.

Składnia

__AllParameterSets

Export-MarkdownCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-OutputFolder <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Opis

To polecenie eksportuje obiekt CommandHelp do pliku markdown. Frontmatter metadanych można dodać do pliku markdown przy użyciu parametru metadanych . Możesz uzyskać obiekt CommandHelp za pomocą polecenia cmdlet Export-MarkdownCommandHelp lub jednego z Import-* poleceń cmdlet.

Przykłady

Przykład 1 — konwertowanie starego języka Markdown pomaga w zawartości do nowego formatu

W tym przykładzie importuje pomoc języka Markdown w starym formacie z folderu .\v1 i eksportuje go do folderu .\v2 w nowym formacie.

$chobj = Import-MarkdownCommandHelp -Path .\v1\Export-YamlModuleFile.md
Export-MarkdownCommandHelp -CommandHelp $chobj -OutputFolder .\v2

    Directory: D:\Git\PS-Src\platyPS\v2docs\v2

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           5/20/2024  3:33 PM           2892 Export-YamlModuleFile.md

Przykład 2 — konwertowanie folderu starego języka Markdown ułatwia zawartość do nowego formatu

W tym przykładzie importuje pomoc języka Markdown w starym formacie z folderu .\v1 i eksportuje go do folderu .\v1\new w nowym formacie. W razie potrzeby Export-MarkdownCommandHelp tworzy foldery docelowe. Nowe pliki markdown są zapisywane w folderze o nazwie dla modułu, do którego należą.

$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Export-MarkdownCommandHelp -OutputFolder .\v1\new

    Directory: D:\Git\PS-Src\platyPS\v2docs\v1\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:30 PM           3194 Compare-CommandHelp.md
-a---           8/26/2024  3:30 PM           4282 Export-MamlCommandHelp.md
-a---           8/26/2024  3:30 PM           6401 Export-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           4874 Export-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           6429 Export-YamlCommandHelp.md
-a---           8/26/2024  3:30 PM           5601 Export-YamlModuleFile.md
-a---           8/26/2024  3:30 PM           2724 Import-MamlHelp.md
-a---           8/26/2024  3:30 PM           3733 Import-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           3870 Import-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           3907 Import-YamlCommandHelp.md
-a---           8/26/2024  3:30 PM           3477 Import-YamlModuleFile.md
-a---           8/26/2024  3:30 PM           2088 Measure-PlatyPSMarkdown.md
-a---           8/26/2024  3:30 PM           4748 New-CommandHelp.md
-a---           8/26/2024  3:30 PM           8647 New-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           5086 New-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           3080 Test-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           3041 Update-CommandHelp.md
-a---           8/26/2024  3:30 PM           3981 Update-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           5548 Update-MarkdownModuleFile.md

Parametry

-CommandHelp

Obiekt CommandHelp do wyeksportowania. Można przekazać obiekt CommandHelp w potoku lub przy użyciu parametru polecenia .

Właściwości parametru

Typ:	Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	0
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	por

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Encoding

Kodowanie do użycia podczas zapisywania pliku markdown. Jeśli żadna wartość nie zostanie określona, kodowanie jest domyślnie wartością zmiennej preferencji $OutputEncoding.

Właściwości parametru

Typ:	Encoding
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Force

Użyj parametru Force, aby zastąpić plik wyjściowy, jeśli już istnieje.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Metadata

Metadane, które mają zostać dodane do frontmatteru pliku markdown. Metadane to tabela skrótu, w której należy określić pary klucz i wartość, które mają zostać dodane do frontmatteru. Nowe nazwy kluczy są dodawane do istniejącego frontmatteru. Wartości istniejących kluczy są zastępowane.

Właściwości parametru

Typ:	Hashtable
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-OutputFolder

Folder, w którym jest zapisywany plik markdown. Jeśli folder nie istnieje, zostanie utworzony.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-WhatIf

Uruchamia polecenie w trybie, który zgłasza tylko to, co się stanie, bez wykonywania akcji.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	False
Obsługuje symbole wieloznaczne:	False
DontShow:	False
Aliasy:	Wi

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Dane wyjściowe

FileInfo

Linki powiązane

• Export-YamlCommandHelp
• Import-MarkdownCommandHelp
• Import-YamlCommandHelp