Met deze opdracht maakt u het Markdown-modulebestand voor een PowerShell-module. Het modulebestand bevat de metagegevens van de module en een lijst met alle opdrachten met hun synopsisbeschrijvingen. Dit bestand kan worden gebruikt als de landingspagina van de module in een documentatieset. De metagegevens van de module worden door Export-MamlCommandHelp gebruikt om het MAML-helpbestand voor de module te maken.
Voorbeelden
Voorbeeld 1: een nieuw modulebestand maken vanuit een map met opdracht-Help-bestanden
De CommandHelp objecten die moeten worden opgenomen in het modulebestand. U kunt het CommandHelp--object doorgeven aan de pijplijn of met behulp van de parameter Command.
Parametereigenschappen
Type:
Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Default value:
None
Ondersteunt jokertekens:
False
DontShow:
False
Parametersets
(All)
Position:
Named
Verplicht:
False
Waarde uit pijplijn:
True
Waarde uit pijplijn op eigenschapsnaam:
False
Waarde van resterende argumenten:
False
-Confirm
Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.
De codering die wordt gebruikt bij het maken van de uitvoerbestanden. Als deze niet is opgegeven, gebruikt de cmdlet de waarde die is opgegeven door $OutputEncoding.
Met deze parameter kunt u de URI opgeven die wordt gebruikt voor bijwerkbare help. De cmdlet gebruikt standaard de HelpInfoUri die is opgegeven in het modulemanifest.
Met deze parameter kunt u de versie van de Help opgeven. De standaardwaarde is 1.0.0.0. Deze versie wordt geschreven naar het HelpInfo.xml-bestand dat wordt gebruikt voor updatebare help.
Met deze parameter kunt u de landinstellingen voor de Help-bestanden opgeven. De cmdlet gebruikt standaard de huidige CultureInfo. Gebruik de cmdlet Get-Culture om de huidige cultuurinstellingen op uw systeem te bekijken.
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. U kunt de waarden van de document type of PlatyPS schema version sleutels niet overschrijven. Als deze sleutels aanwezig zijn in de hashtabel, negeert de cmdlet de waarden en voert een waarschuwing uit.
Hiermee geeft u de locatie op van waar het Markdown-modulebestand wordt geschreven. De cmdlet maakt een map voor elke module op basis van de CommandHelp object dat wordt verwerkt.