Import-MarkdownCommandHelp
Importerar Markdown-hjälpinnehåll till CommandHelp- objekt.
Syntax
Path (Standard)
Import-MarkdownCommandHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MarkdownCommandHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Kommandot importerar Markdown-filer som innehåller kommandohjälp och skapar CommandHelp objekt. Objektet CommandHelp är en strukturerad representation av hjälpinnehållet som kan användas för att exportera till olika format.
Exempel
Exempel 1 – Importera alla markdown-cmdlet-filer i en mapp
I följande exempel importerar du markdown-filer i en mapp och konverterar dem till CommandHelp- objekt. Dessa objekt kan användas för att exportera till olika format.
$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
Select-Object Title
Title
-----
Compare-CommandHelp
Export-MamlCommandHelp
Export-MarkdownCommandHelp
Export-MarkdownModuleFile
Export-YamlCommandHelp
Export-YamlModuleFile
Import-MamlHelp
Import-MarkdownCommandHelp
Import-MarkdownModuleFile
Import-YamlCommandHelp
Import-YamlModuleFile
Measure-PlatyPSMarkdown
New-CommandHelp
New-MarkdownCommandHelp
New-MarkdownModuleFile
Test-MarkdownCommandHelp
Update-CommandHelp
Update-MarkdownCommandHelp
Update-MarkdownModuleFile
Parametrar
-LiteralPath
Anger en sökväg till en eller flera platser som innehåller markdown-filer. Värdet för LiteralPath- används exakt som det skrivs. Inga tecken tolkas som wildcards. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.
Mer information finns i about_Quoting_Rules.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | PSPath, SP |
Parameteruppsättningar
LiteralPath
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Path
Anger sökvägen till ett objekt. Den här cmdleten hämtar objektet på den angivna platsen. Jokertecken tillåts. Den här parametern krävs, men parameternamnet Sökväg är valfri.
Använd en punkt (.) för att ange den aktuella platsen. Använd jokertecknet (*) för att ange alla objekt på den aktuella platsen.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | True |
| DontShow: | False |
Parameteruppsättningar
Path
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter egenskapsnamn: | 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.