Import-MarkdownModuleFile
Importerar en Markdown-modulfil till ett ModuleHelp--objekt.
Syntax
Path (Standard)
Import-MarkdownModuleFile
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MarkdownModuleFile
-LiteralPath <string[]>
[<CommonParameters>]
Beskrivning
Kommandot importerar Markdown-filer som innehåller modulhjälp och skapar ModuleHelp- objekt. Objektet ModuleHelp är en strukturerad representation av hjälpinnehållet som kan användas för att exportera till olika format.
Exempel
Exempel 1 – Konvertera
Import-MarkdownModuleFile .\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
Metadata : {[document type, module], [HelpInfoUri, ], [Locale, en-US], [Module Guid,
0bdcabef-a4b7-4a6d-bf7e-d879817ebbff]…}
Title : Microsoft.PowerShell.PlatyPS Module
Module : Microsoft.PowerShell.PlatyPS
ModuleGuid : 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff
Description : This module contains cmdlets to help with the creation help content for PowerShell commands.
Locale : en-US
CommandGroups : {Microsoft.PowerShell.PlatyPS.ModuleCommandGroup}
Diagnostics : Microsoft.PowerShell.PlatyPS.Model.Diagnostics
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 jokrar: | False |
| DontShow: | False |
| Alias: | PSPath, SP |
Parametermängder
LiteralPath
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter fastighetsnamn: | 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 jokrar: | True |
| DontShow: | False |
Parametermängder
Path
| 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 |
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.