Dela via


New-MarkdownCommandHelp

Skapar Markdown-hjälpfiler för PowerShell-moduler och -kommandon.

Syntax

__AllParameterSets

New-MarkdownCommandHelp
    -OutputFolder <string>
    [-CommandInfo <CommandInfo[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpUri <string>]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-ModuleInfo <psmoduleinfo[]>]
    [-WithModulePage]
    [-AbbreviateParameterTypename]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Skapar Markdown-hjälpfiler för PowerShell-moduler och -kommandon.

Exempel

Exempel 1 – Skapa Markdown-hjälpfiler för en modul

$newMarkdownCommandHelpSplat = @{
    ModuleInfo = Get-Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Exempel 2 – Skapa Markdown-hjälpfiler från en lista med kommandon

$newMarkdownCommandHelpSplat = @{
    CommandInfo = Get-Command -Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Parametrar

-AbbreviateParameterTypename

Som standard använder det här kommandot fullständiga typnamn i parametermetadata och för indata- och utdatatyperna. När du använder den här parametern matar cmdleten ut korta typnamn.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CommandInfo

En lista över ett eller flera kommandon att skapa hjälp för.

Parameteregenskaper

Typ:

CommandInfo[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Encoding

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

Parameteregenskaper

Typ:Encoding
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-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

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-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

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-HelpUri

Med den här parametern kan du ange den URI som används för onlinehjälp. Som standard använder cmdleten den URI som definierats i attributet [CmdletBinding()] för kommandot.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-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

Typ:Version
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-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

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-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

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ModuleInfo

En lista över en eller flera moduler att skapa hjälp för. Cmdleten skapar Markdown-hjälpfiler för alla kommandon i modulen. Cmdleten skapar en mapp som matchar namnet på modulen på utdataplatsen. Alla Markdown-filer skrivs till modulmappen.

Parameteregenskaper

Typ:

PSModuleInfo[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-OutputFolder

Anger platsen där Markdown-hjälpfilerna skrivs. Cmdleten skapar en mapp för varje modul som bearbetas. Om målkommandot inte är associerat med en modul skapar cmdleten en Markdown-fil i roten i utdatamappen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WithModulePage

Som standard skapar den här cmdleten endast Markdown-filer för kommandon. När du använder den här parametern skapar cmdleten en Markdown-fil för modulen. Den här Markdown-filen innehåller en lista över alla kommandon i modulen och metadata som används för att skapa HelpInfo.xml-filen.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

CommandInfo

PSModuleInfo

Utdata

FileInfo