Export-MarkdownCommandHelp

Modul:
Microsoft.PowerShell.PlatyPS Module

CommandHelp objektumot exportál egy Markdown-fájlba.

Szintaxis

__AllParameterSets 

Export-MarkdownCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-OutputFolder <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Leírás

Ez a parancs exportál egy CommandHelp objektumot egy Markdown-fájlba. A metaadatok kezelőfelületét a Metadata paraméterrel adhatja hozzá a Markdown-fájlhoz. CommandHelp objektumot a Export-MarkdownCommandHelp parancsmaggal vagy az Import-* parancsmagok egyikével szerezheti be.

Példák

1. példa – Régi Markdown súgótartalmak átalakítása új formátumra

Ez a példa importálja a Markdown-súgót a régi formátumban a .\v1 mappából, és exportálja az új formátumban lévő .\v2 mappába.

$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

2. példa – Régi Markdown-súgótartalom mappa átalakítása új formátumba

Ez a példa importálja a Markdown-súgót a régi formátumban a .\v1 mappából, és exportálja az új formátumban lévő .\v1\new mappába. Szükség esetén Export-MarkdownCommandHelp hozza létre a célmappát. Az új Markdown-fájlok az ahhoz a modulhoz tartozó mappába vannak írva, amelyhez tartoznak.

$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

Paraméterek

-CommandHelp

A CommandHelp exportálni kívánt objektumot. A CommandHelp objektumot a folyamaton vagy a Command paraméterrel adhatja át.

Paramétertulajdonságok

Típus:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Alapértelmezett érték:None
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:0
Kötelező:True
Érték a csővezetékből:True
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-Confirm

Megerősítést kér a parancsmag futtatása előtt.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogató vadkártyák:False
Don't Show:False
Aliasok:Cf

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-Encoding

A markdown-fájl írásakor használandó kódolás. Ha nincs megadva érték, a kódolás alapértelmezés szerint a $OutputEncoding beállítási változó értékét adja meg.

Paramétertulajdonságok

Típus:Encoding
Alapértelmezett érték:False
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-Force

Ha már létezik, a Kényszerítse paramétert a kimeneti fájl felülírásához.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-Metadata

A markdown-fájl előteréhez hozzáadni kívánt metaadatok. A metaadatok kivonatolók, ahol a kulcs- és értékpárokat adja meg az előtérhez. A rendszer új kulcsneveket ad hozzá a meglévő előtérhez. A meglévő kulcsok értékei felülíródnak.

Paramétertulajdonságok

Típus:Hashtable
Alapértelmezett érték:None
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-OutputFolder

Az a mappa, amelyben a Markdown-fájl mentésre kerül. Ha a mappa nem létezik, létrejön.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

-WhatIf

A parancsot olyan módban futtatja, amely csak azt jelenti, hogy mi történne a műveletek végrehajtása nélkül.

Paramétertulajdonságok

Típus:SwitchParameter
Alapértelmezett érték:False
Támogató vadkártyák:False
Don't Show:False
Aliasok:Wi

Paraméterhalmazok

(All)
Pozíció:Named
Kötelező:False
Érték a csővezetékből:False
Érték a csővezetékből az ingatlan név szerint:False
Érték a maradék argumentumokból:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bemenetek

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Kimenetek

FileInfo