Export-MarkdownCommandHelp
Hiermee exporteert u een CommandHelp -object naar een Markdown-bestand.
Syntaxis
__AllParameterSets
Export-MarkdownCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Met deze opdracht exporteert u een CommandHelp -object naar een Markdown-bestand. U kunt frontmatter voor metagegevens toevoegen aan het Markdown-bestand met behulp van de parameter Metagegevens . U kunt een CommandHelp -object ophalen met behulp van de Export-MarkdownCommandHelp-cmdlet of een van de Import-* cmdlets.
Voorbeelden
Voorbeeld 1: Oude Markdown-help-inhoud converteren naar de nieuwe indeling
In dit voorbeeld importeert u Markdown Help in de oude indeling uit de .\v1 map en exporteert u deze naar de .\v2 map in de nieuwe indeling.
$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
Voorbeeld 2: een map met oude Markdown-help-inhoud converteren naar de nieuwe indeling
In dit voorbeeld importeert u Markdown Help in de oude indeling uit de .\v1 map en exporteert u deze naar de .\v1\new map in de nieuwe indeling. Indien nodig maakt Export-MarkdownCommandHelp de doelmappen. De nieuwe Markdown-bestanden worden geschreven naar de map met de naam van de module waartoe ze behoren.
$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
Parameters
-CommandHelp
Het CommandHelp -object dat u wilt exporteren. U kunt het CommandHelp- -object doorgeven aan de pijplijn of met behulp van de parameter Command .
Parametereigenschappen
Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp [ ]
Default value: None Ondersteunt jokertekens: False DontShow: False
Parametersets
(All)
Position: 0 Verplicht: True Waarde uit pijplijn: True Waarde uit pijplijn op eigenschapsnaam: False Waarde van resterende argumenten: False
-Confirm
Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.
Parametereigenschappen
Type: SwitchParameter
Default value: False Ondersteunt jokertekens: False DontShow: False Aliassen: Cf
Parametersets
(All)
Position: Named Verplicht: False Waarde uit pijplijn: False Waarde uit pijplijn op eigenschapsnaam: False Waarde van resterende argumenten: False
-Encoding
De codering die moet worden gebruikt bij het schrijven van het Markdown-bestand. Als er geen waarde is opgegeven, wordt standaard de waarde van de $OutputEncoding voorkeursvariabele gecodeerd.
Parametereigenschappen
Type: Encoding
Default value: False Ondersteunt jokertekens: False DontShow: False
Parametersets
(All)
Position: Named Verplicht: False Waarde uit pijplijn: False Waarde uit pijplijn op eigenschapsnaam: False Waarde van resterende argumenten: False
-Force
Gebruik de parameter Forceren om het uitvoerbestand te overschrijven als het al bestaat.
Parametereigenschappen
Type: SwitchParameter
Default value: False Ondersteunt jokertekens: False DontShow: False
Parametersets
(All)
Position: Named Verplicht: False Waarde uit pijplijn: False Waarde uit pijplijn op eigenschapsnaam: False Waarde van resterende argumenten: False
De metagegevens die moeten worden toegevoegd aan de frontmatter van het Markdown-bestand. De metagegevens zijn een hashtabel waarbij u de sleutel- en waardeparen opgeeft die moeten worden toegevoegd aan de frontmatter. Nieuwe sleutelnamen worden toegevoegd aan de bestaande frontmatter. De waarden van bestaande sleutels worden overschreven.
Type: Hashtable
Default value: None Ondersteunt jokertekens: False DontShow: False
(All)
Position: Named Verplicht: False Waarde uit pijplijn: False Waarde uit pijplijn op eigenschapsnaam: False Waarde van resterende argumenten: False
-OutputFolder
De map waarin het Markdown-bestand is opgeslagen. Als de map niet bestaat, wordt deze gemaakt.
Parametereigenschappen
Type: String
Default value: None Ondersteunt jokertekens: False DontShow: False
Parametersets
(All)
Position: Named Verplicht: False Waarde uit pijplijn: False Waarde uit pijplijn op eigenschapsnaam: False Waarde van resterende argumenten: False
-WhatIf
Voert de opdracht uit in een modus die alleen rapporteert wat er zou gebeuren zonder de acties uit te voeren.
Parametereigenschappen
Type: SwitchParameter
Default value: False Ondersteunt jokertekens: False DontShow: False Aliassen: Wi
Parametersets
(All)
Position: Named Verplicht: False Waarde uit pijplijn: False Waarde uit pijplijn op eigenschapsnaam: False Waarde van resterende argumenten: False
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParameters voor meer informatie.
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Uitvoerwaarden