New-MarkdownModuleFile

Syntax

__AllParameterSets

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

Description

Exempel

Exempel 1 – Skapa en ny modulfil från en mapp med kommandohjälpfiler

$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

Exempel 2 – Skapa en ny modulfil från en lista med kommandon

$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

Parametrar

-CommandHelp

CommandHelp objekt som ska ingå i modulfilen. Du kan skicka objektet CommandHelp i pipelinen eller med hjälp av parametern Kommando.

Parameteregenskaper

Parameteruppsättningar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Parameteruppsättningar

-Encoding

Kodningen som används när du skapar utdatafilerna. Om det inte anges använder cmdleten värdet som anges av $OutputEncoding.

Parameteregenskaper

Parameteruppsättningar

-Force

Som standard skriver det här kommandot inte över befintliga filer. När du använder den här parametern skriver cmdleten över befintliga filer.

Parameteregenskaper

Parameteruppsättningar

-HelpInfoUri

Med den här parametern kan du ange den URI som används för uppdateringsbar hjälp. Som standard använder cmdleten den HelpInfoUri som anges i modulmanifestet.

Parameteregenskaper

Parameteruppsättningar

-HelpVersion

Med den här parametern kan du ange vilken version av hjälpen som ska användas. Standardvärdet är 1.0.0.0. Den här versionen skrivs till den HelpInfo.xml fil som används för uppdateringsbar hjälp.

Parameteregenskaper

Parameteruppsättningar

-Locale

Med den här parametern kan du ange språkspråket för hjälpfilerna. Som standard använder cmdleten den aktuella CultureInfo-. Använd cmdleten Get-Culture för att se de aktuella kulturinställningarna i systemet.

Parameteregenskaper

Parameteruppsättningar

-Metadata

Metadata som ska läggas till i markdown-filens frontmatter. Metadata är en hashtable där du anger nyckel- och värdeparen som ska läggas till i frontmattern. Nya nyckelnamn läggs till i den befintliga frontmattern. Värdena för befintliga nycklar skrivs över. Du kan inte skriva över värdena för document type eller PlatyPS schema version nycklar. Om dessa nycklar finns i hashtabellen ignorerar cmdleten värdena och utdata en varning.

Parameteregenskaper

Parameteruppsättningar

-OutputFolder

Anger platsen där Markdown-modulfilen skrivs. Cmdleten skapar en mapp för varje modul baserat på CommandHelp objekt som bearbetas.

Parameteregenskaper

Parameteruppsättningar

-WhatIf

Kör kommandot i ett läge som bara rapporterar vad som skulle hända utan att utföra åtgärderna.

Parameteregenskaper

Parameteruppsättningar

CommonParameters

Indata

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Utdata

FileInfo

Relaterade länkar

• Export-MarkdownModuleFile
• Update-MarkdownModuleFile