Export-MarkdownCommandHelp
CommandHelp nesnesini markdown dosyasına aktarır.
Syntax
__AllParameterSets
Export-MarkdownCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Bu komut, bir CommandHelp nesnesini markdown dosyasına aktarır.
Metadata parametresini kullanarak markdown dosyasına meta veri ön modeli ekleyebilirsiniz.
cmdlet'ini veya Export-MarkdownCommandHelp cmdlet'lerinden birini kullanarak Import-* nesnesi alabilirsiniz.
Örnekler
Örnek 1 - Eski Markdown yardım içeriğini yeni biçime dönüştürme
Bu örnek, Markdown yardımını .\v1 klasöründen eski biçimde içeri aktarır ve yeni biçimde .\v2 klasörüne aktarır.
$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
Örnek 2 - Eski Markdown yardım içeriğinin bir klasörünü yeni biçime dönüştürme
Bu örnek, Markdown yardımını .\v1 klasöründen eski biçimde içeri aktarır ve yeni biçimde .\v1\new klasörüne aktarır. Gerekirse Export-MarkdownCommandHelp hedef klasörleri oluşturur. Yeni markdown dosyaları, ait oldukları modül için adlı klasöre yazılı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
Parametreler
-CommandHelp
Dışarı aktaracak CommandHelp nesnesi.
CommandHelp nesnesini işlem hattında veya Command parametresini kullanarak geçirebilirsiniz.
Parametre özellikleri
Tür: Microsoft.PowerShell.PlatyPS.Model.CommandHelp [ ]
Default value: None Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
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
-Confirm
Cmdlet'i çalıştırmadan önce sizden onay ister.
Parametre özellikleri
Tür: SwitchParameter
Default value: False Joker karakterleri destekler: False DontShow: False Diğer adlar: Cf
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Ö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
-Encoding
Markdown dosyası yazılırken kullanılacak kodlama. Değer belirtilmezse kodlama varsayılan olarak $OutputEncoding tercih değişkeninin değerine ayarlanır.
Parametre özellikleri
Tür: Encoding
Default value: False Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Ö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
-Force
Çıktı dosyasının zaten varsa üzerine yazmak için Zorla parametresini kullanın.
Parametre özellikleri
Tür: SwitchParameter
Default value: False Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Ö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
Markdown dosyasının ön modeline eklenecek meta veriler. Meta veriler, ön modele eklenecek anahtar ve değer çiftlerini belirttiğiniz bir karma tablodur. Mevcut ön modele yeni anahtar adları eklenir. Varolan anahtarların değerlerinin üzerine yazılır.
Tür: Hashtable
Default value: None Joker karakterleri destekler: False DontShow: False
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Ö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
-OutputFolder
Markdown dosyasının kaydedildiği klasör. Klasör yoksa oluşturulur.
Parametre özellikleri
Tür: String
Default value: None Joker karakterleri destekler: False DontShow: False
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Ö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
-WhatIf
Komutu, eylemleri gerçekleştirmeden yalnızca ne olacağını bildiren bir modda çalıştırır.
Parametre özellikleri
Tür: SwitchParameter
Default value: False Joker karakterleri destekler: False DontShow: False Diğer adlar: Wi
Parametre kümeleri
(All)
Position: Named Zorunlu: False İşlem hattından gelen değer: False Ö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 .
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
Çıkışlar