Import-MarkdownCommandHelp
Markdown yardım içeriğini CommandHelp nesnelerine aktarır.
Syntax
Path (Varsayılan)
Import-MarkdownCommandHelp
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MarkdownCommandHelp
-LiteralPath <string[]>
[<CommonParameters>]
Description
Komut, komut yardımı içeren Markdown dosyalarını içeri aktarır ve CommandHelp nesneleri oluşturur. CommandHelp nesnesi, farklı biçimlere dışarı aktarmak için kullanılabilecek yardım içeriğinin yapılandırılmış bir gösterimidir.
Örnekler
Örnek 1 - Klasördeki tüm cmdlet Markdown dosyalarını içeri aktarma
Aşağıdaki örnek, cmdlet Markdown dosyalarını bir klasöre içeri aktarır ve bunları CommandHelp nesnelerine dönüştürür. Bu nesneler farklı biçimlere dışarı aktarmak için kullanılabilir.
$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
Parametreler
-LiteralPath
Markdown dosyalarını içeren bir veya daha fazla konumun yolunu belirtir. LiteralPath değeri tam olarak yazıldığı gibi kullanılır. Hiçbir karakter joker karakter olarak yorumlanmamıştır. Yol kaçış karakterleri içeriyorsa, yolu tek tırnak işaretleriyle çevreleyin. Tek tırnak işaretleri, PowerShell'in hiçbir karakteri kaçış dizisi olarak yorumlamamasını sağlar.
Daha fazla bilgi için bkz. about_Quoting_Rules.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | PSPath, LP |
Parametre kümeleri
LiteralPath
| Position: | Named |
| Zorunlu: | True |
| İşlem hattından gelen değer: | True |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Path
Bir öğenin yolunu belirtir. Bu cmdlet öğeyi belirtilen konumda alır. Joker karakterlere izin verilir. Bu parametre gereklidir, ancak Path parametre adı isteğe bağlıdır.
Geçerli konumu belirtmek için nokta (.) kullanın. Geçerli konumdaki tüm öğeleri belirtmek için joker karakteri (*) kullanın.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | True |
| DontShow: | False |
Parametre kümeleri
Path
| Position: | 0 |
| Zorunlu: | True |
| İşlem hattından gelen değer: | True |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
CommonParameters
Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.