Delen via

Export-MarkdownModuleFile

Module:
Microsoft.PowerShell.PlatyPS Module

Hiermee exporteert u een ModuleFileInfo--object naar een Markdown-bestand.

Syntaxis

__AllParameterSets 

Export-MarkdownModuleFile
    [-ModuleFileInfo] <ModuleFileInfo[]>
    [-Encoding <Encoding>]
    [-Force]
    [-Metadata <hashtable>]
    [-OutputFolder <string>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Met deze opdracht exporteert u een ModuleFileInfo--object naar een Markdown-bestand. U kunt frontmatter voor metagegevens toevoegen aan het Markdown-bestand met behulp van de parameter Metagegevens. U kunt een ModuleFileInfo-object ophalen met behulp van de cmdlet Import-MarkdownModuleFile. U kunt een modulebestand importeren dat is geschreven in de oude indeling en exporteren naar de nieuwe indeling.

Voorbeelden

Voorbeeld 1: een oud modulebestand converteren naar de nieuwe indeling

In dit voorbeeld wordt een ModuleFileInfo-object door een Markdown-modulebestand te importeren uit de map .\v1. Dat object wordt vervolgens geëxporteerd naar een Markdown-bestand in de nieuwe indeling met behulp van de Export-MarkdownModuleFile.

Import-MarkdownModuleFile -Path .\v1\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md |
    Export-MarkdownModuleFile -OutputFolder .\v1\new\Microsoft.PowerShell.PlatyPS -Force

    Directory: D:\Git\PS-Src\platyPS\v2docs\v1\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:38 PM           2716 Microsoft.PowerShell.PlatyPS.md

Parameters

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Encoding

De codering die moet worden gebruikt bij het schrijven van het Markdown-bestand. Als er geen waarde is opgegeven, wordt standaard de waarde van de $OutputEncoding voorkeursvariabele gecodeerd.

Parametereigenschappen

Type:Encoding
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

Gebruik de parameter Forceren om het uitvoerbestand te overschrijven als het al bestaat.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Metadata

De metagegevens die moeten worden toegevoegd aan de frontmatter van het Markdown-bestand. De metagegevens zijn een hashtabel waarbij u de sleutel- en waardeparen opgeeft die moeten worden toegevoegd aan de frontmatter. Nieuwe sleutelnamen worden toegevoegd aan de bestaande frontmatter. De waarden van bestaande sleutels worden overschreven.

Parametereigenschappen

Type:Hashtable
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ModuleFileInfo

Het ModuleFileInfo-object om te exporteren naar een Markdown-bestand. Dit object wordt gemaakt door de cmdlet Import-MarkdownModuleFile.

Parametereigenschappen

Type:

Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]

Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:0
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-OutputFolder

De map waarin het Markdown-bestand is opgeslagen. Als de map niet bestaat, wordt deze gemaakt.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Voert de opdracht uit in een modus die alleen rapporteert wat er zou gebeuren zonder de acties uit te voeren.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

Microsoft.PowerShell.PlatyPS.ModuleFileInfo

Uitvoerwaarden

FileInfo