Import-MarkdownCommandHelp
Hiermee importeert u Help-inhoud van Markdown in CommandHelp-objecten.
Syntaxis
Path (Standaard)
Import-MarkdownCommandHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MarkdownCommandHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Met de opdracht importeert u Markdown-bestanden met opdrachthulp en maakt u CommandHelp-objecten. Het CommandHelp-object is een gestructureerde weergave van de Help-inhoud die kan worden gebruikt voor het exporteren naar verschillende indelingen.
Voorbeelden
Voorbeeld 1: alle Markdown-cmdlet-bestanden in een map importeren
In het volgende voorbeeld worden Markdown-cmdlet-bestanden in een map geïmporteerd en geconverteerd naar CommandHelp--objecten. Deze objecten kunnen worden gebruikt om te exporteren naar verschillende indelingen.
$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
Parameters
-LiteralPath
Hiermee geeft u een pad naar een of meer locaties met Markdown-bestanden. De waarde van LiteralPath- wordt precies gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
Zie about_Quoting_Rulesvoor meer informatie.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
LiteralPath
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Path
Hiermee geeft u het pad naar een item. Met deze cmdlet krijgt u het item op de opgegeven locatie. Jokertekens zijn toegestaan. Deze parameter is vereist, maar het pad van de parameternaam is optioneel.
Gebruik een punt (.) om de huidige locatie op te geven. Gebruik het jokerteken (*) om alle items op de huidige locatie op te geven.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
Path
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| 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_CommonParametersvoor meer informatie.