Export-MarkdownCommandHelp
Exporterar ett CommandHelp- -objekt till en markdown-fil.
Syntax
__AllParameterSets
Export-MarkdownCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beskrivning
Det här kommandot exporterar ett CommandHelp- -objekt till en markdown-fil. Du kan lägga till frontmatter för metadata i markdown-filen med hjälp av parametern Metadata . Du kan hämta ett CommandHelp- -objekt med hjälp av cmdleten Export-MarkdownCommandHelp eller någon av de Import-* cmdletarna.
Exempel
Det här exemplet importerar Markdown-hjälpen i det gamla formatet från mappen .\v1 och exporterar den till mappen .\v2 i det nya formatet.
$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
Det här exemplet importerar Markdown-hjälpen i det gamla formatet från mappen .\v1 och exporterar den till mappen .\v1\new i det nya formatet. Om det behövs skapar Export-MarkdownCommandHelp målmapparna. De nya markdown-filerna skrivs till mappen med namnet för den modul som de tillhör.
$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
Parametrar
-CommandHelp
CommandHelp objekt som ska exporteras. Du kan skicka objektet CommandHelp i pipelinen eller med hjälp av parametern Kommando .
Parameteregenskaper
Typ: Microsoft.PowerShell.PlatyPS.Model.CommandHelp [ ]
Standardvärde: None Stöder jokrar: False DontShow: False
Parametermängder
(All)
Position: 0 Obligatorisk: True Värde från pipeline: True Värde från pipeline efter fastighetsnamn: False Värde från återstående argument: False
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Parameteregenskaper
Typ: SwitchParameter
Standardvärde: False Stöder jokrar: False DontShow: False Alias: jfr
Parametermängder
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter fastighetsnamn: False Värde från återstående argument: False
-Encoding
Den kodning som ska användas när du skriver markdown-filen. Om inget värde anges kodas som standard värdet för $OutputEncoding-inställningsvariabeln.
Parameteregenskaper
Typ: Encoding
Standardvärde: False Stöder jokrar: False DontShow: False
Parametermängder
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter fastighetsnamn: False Värde från återstående argument: False
-Force
Använd parametern Force för att skriva över utdatafilen om den redan finns.
Parameteregenskaper
Parametermängder
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter fastighetsnamn: False Värde från återstående argument: False
Metadata som ska läggas till i markdown-filens frontmatter. Metadata är en hashtable där du anger nyckel- och värdeparen som ska läggas till i frontmattern. Nya nyckelnamn läggs till i den befintliga frontmattern. Värdena för befintliga nycklar skrivs över.
Typ: Hashtable
Standardvärde: None Stöder jokrar: False DontShow: False
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter fastighetsnamn: False Värde från återstående argument: False
-OutputFolder
Mappen där markdown-filen sparas. Om mappen inte finns skapas den.
Parameteregenskaper
Typ: String
Standardvärde: None Stöder jokrar: False DontShow: False
Parametermängder
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter fastighetsnamn: False Värde från återstående argument: False
-WhatIf
Kör kommandot i ett läge som bara rapporterar vad som skulle hända utan att utföra åtgärderna.
Parameteregenskaper
Typ: SwitchParameter
Standardvärde: False Stöder jokrar: False DontShow: False Alias: Wi
Parametermängder
(All)
Position: Named Obligatorisk: False Värde från pipeline: False Värde från pipeline efter fastighetsnamn: False Värde från återstående argument: False
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters .
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Utgångar