Freigeben über

New-MarkdownAboutHelp

  • Referenz
Modul:
platyPS

Generiert eine neue About Topic MD-Datei aus vorlage.

Syntax

New-MarkdownAboutHelp
   [-OutputFolder] <String>
   [[-AboutName] <String>]
   [<CommonParameters>]

Beschreibung

Das Cmdlet New-MarkdownAboutHelp generiert eine Markdown-Datei, die vorab mit den Standardelementen eines Themas aufgefüllt wird. Das Cmdlet kopiert die Vorlage MD, benennt Kopfzeilen und Dateinamen gemäß dem parameter AboutName um und legt die Datei in dem Verzeichnis ein, das vom OutputFolder Parameter festgelegt ist.

Das Thema "Info" kann in das Txt-Format konvertiert werden. Informationen zu Themen müssen im TXT-Format vorliegen, oder das PowerShell-Hilfemodul kann das Dokument nicht analysieren. Verwenden Sie das Cmdlet New-ExternalHelp, um Informationen zu Themenmarkdowndateien in "About Topic txt"-Dateien zu konvertieren.

Beispiele

Beispiel 1

PS C:\> New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName TestAboutTopic
PS C:\> Get-ChildItem C:\Test

    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:12 PM           1491 about_TestAboutTopic.md

Erstellen und Anzeigen von Dateiinformationen für PowerShell zu Themenmarkdowndatei.

Beispiel 2

PS C:\> New-ExternalHelp -Path C:\Test\ -OutputPath C:\Test


    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:15 PM           1550 about_TestAboutTopic.help.txt

Erstellen Sie powerShell About Topic Txt-Datei aus der vorhandenen Markdown About-Datei.

Parameter

-AboutName

Der Name des Themas.

Typ:String
Position:1
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-OutputFolder

Das Verzeichnis, in dem das Thema erstellt werden soll.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Ausgaben

Object

Dieses Cmdlet gibt ein Objekt für erstellte Dateien zurück.

Hinweise

Die Informationen zu Themen müssen einer CAB-Datei hinzugefügt werden, um aktualisierbare Hilfe zu nutzen.