Freigeben über

Export-MarkdownCommandHelp

Modul:
Microsoft.PowerShell.PlatyPS Module

Exportiert ein CommandHelp--Objekt in eine Markdowndatei.

Syntax

__AllParameterSets 

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

Beschreibung

Mit diesem Befehl wird ein CommandHelp--Objekt in eine Markdowndatei exportiert. Sie können der Markdowndatei Metadaten-Frontmatter hinzufügen, indem Sie den Parameter Metadata verwenden. Sie können ein CommandHelp--Objekt abrufen, indem Sie das cmdlet Export-MarkdownCommandHelp oder eines der Import-*-Cmdlets verwenden.

Beispiele

Beispiel 1 : Konvertieren alter Markdown-Hilfeinhalte in das neue Format

In diesem Beispiel wird die Markdown-Hilfe im alten Format aus dem ordner .\v1 importiert und in den Ordner .\v2 im neuen Format exportiert.

$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

Beispiel 2 : Konvertieren eines Ordners mit alten Markdown-Hilfeinhalten in das neue Format

In diesem Beispiel wird die Markdown-Hilfe im alten Format aus dem ordner .\v1 importiert und in den Ordner .\v1\new im neuen Format exportiert. Bei Bedarf erstellt Export-MarkdownCommandHelp die Zielordner. Die neuen Markdowndateien werden in den Ordner geschrieben, der für das Modul benannt ist, zu dem sie gehören.

$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

Parameter

-CommandHelp

Das CommandHelp- zu exportierende Objekt. Sie können das CommandHelp-objekt an die Pipeline übergeben oder den parameter Command verwenden.

Parametereigenschaften

Typ:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:0
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:vgl

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Encoding

Die Codierung, die beim Schreiben der Markdowndatei verwendet werden soll. Wenn kein Wert angegeben ist, wird standardmäßig der Wert der $OutputEncoding Einstellungsvariablen codiert.

Parametereigenschaften

Typ:Encoding
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Force

Verwenden Sie den parameter Force, um die Ausgabedatei zu überschreiben, sofern sie bereits vorhanden ist.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Metadata

Die Metadaten, die dem Frontmatter der Markdowndatei hinzugefügt werden sollen. Die Metadaten sind eine Hashtabelle, in der Sie die Schlüssel- und Wertpaare angeben, die dem Frontmatter hinzugefügt werden sollen. Der vorhandenen Frontmatter werden neue Schlüsselnamen hinzugefügt. Die Werte vorhandener Schlüssel werden überschrieben.

Parametereigenschaften

Typ:Hashtable
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-OutputFolder

Der Ordner, in dem die Markdowndatei gespeichert wird. Wenn der Ordner nicht vorhanden ist, wird er erstellt.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-WhatIf

Führt den Befehl in einem Modus aus, der nur meldet, was passieren würde, ohne die Aktionen auszuführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Ausgaben

FileInfo