New-MarkdownModuleFile

Modül:
Microsoft.PowerShell.PlatyPS Module

PowerShell modülü için Markdown modül dosyasını oluşturur.

Syntax

__AllParameterSets 

New-MarkdownModuleFile
    -OutputFolder <string>
    [-CommandHelp <CommandHelp[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Bu komut bir PowerShell modülü için Markdown modül dosyasını oluşturur. Modül dosyası, modül meta verilerini ve bunların özet açıklamalarını içeren tüm komutların listesini içerir. Bu dosya, bir belge kümesinde modül giriş sayfası olarak kullanılabilir. Modül meta verileri, modülün MAML yardım dosyasını oluşturmak için Export-MamlCommandHelp tarafından kullanılır.

Örnekler

Örnek 1 - Komut yardım dosyaları klasöründen yeni modül dosyası oluşturma

$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    New-MarkdownModuleFile -OutputFolder .\v2 -Force

    Directory: D:\Docs\v2\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

Örnek 2 - Komut listesinden yeni modül dosyası oluşturma

$newMarkdownCommandHelpSplat = @{
    CommandHelp  = Get-Command -Module Microsoft.PowerShell.PlatyPS | New-CommandHelp
    OutputFolder = '.\new'
    Force        = $true
}
New-MarkdownModuleFile @newMarkdownCommandHelpSplat

    Directory: D:\Docs\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

Parametreler

-CommandHelp

CommandHelp, modül dosyasına eklenecek nesneleri. 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:Named
Zorunlu:False
İş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

Çıkış dosyalarını oluştururken kullanılan kodlama. Belirtilmezse, cmdlet $OutputEncodingtarafından belirtilen değeri kullanır.

Parametre özellikleri

Tür:Encoding
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

-Force

Varsayılan olarak, bu komut var olan dosyaların üzerine yazmaz. Bu parametreyi kullandığınızda, cmdlet var olan dosyaların üzerine yazar.

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

-HelpInfoUri

Bu parametre, güncelleştirilebilir yardım için kullanılan URI'yi belirtmenize olanak tanır. Cmdlet varsayılan olarak modül bildiriminde belirtilen HelpInfoUri'yi kullanır.

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

-HelpVersion

Bu parametre yardımın sürümünü belirtmenize olanak tanır. Varsayılan değer şudur: 1.0.0.0. Bu sürüm, güncelleştirilebilir yardım için kullanılan HelpInfo.xml dosyasına yazılır.

Parametre özellikleri

Tür:Version
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

-Locale

Bu parametre, yardım dosyaları için dil yerel ayarını belirtmenize olanak tanır. Cmdlet varsayılan olarak geçerli CultureInfokullanır. Sisteminizdeki geçerli kültür ayarlarını görmek için Get-Culture cmdlet'ini kullanın.

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

-Metadata

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. document type veya PlatyPS schema version anahtarlarının değerlerinin üzerine yazamazsınız. Bu anahtarlar karma tablo içinde varsa, cmdlet değerleri yoksayar ve bir uyarı verir.

Parametre özellikleri

Tür:Hashtable
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

-OutputFolder

Markdown modül dosyasının yazıldığı konumu belirtir. Cmdlet, işlenen CommandHelp nesnesini temel alarak her modül için bir klasör oluşturur.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:True
İş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.

Girişler

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Çıkışlar

FileInfo