PlatyPS-Übersicht

PlatyPS- ist das primäre Tool zum Erstellen der PowerShell-Hilfe, die mithilfe von Get-Helpangezeigt wird. PowerShell-Hilfedateien werden in einem XML-Format gespeichert, das als Microsoft Assistance Markup Language (MAML) bezeichnet wird. Vor PlatyPSwurden die Hilfedateien mithilfe komplexer Werkzeugketten erstellt. Markdown- wird in der Open Source-Community häufig verwendet, unterstützt von vielen Editoren, darunter Visual Studio Codeund einfacher zu erstellen. PlatyPS vereinfacht den Prozess, indem Sie die Hilfedateien in Markdown schreiben und dann in MAML konvertieren können.

Es gibt zwei Hauptversionen von PlatyPS.

• platyPS v0.14.2 ist die aktuelle Version von PlatyPS, die zum Erstellen von PowerShell-Hilfedateien im Markdown-Format verwendet wird.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 ist die neue Version von PlatyPS. Diese Version ist eine vollständige Neuschreibung in C#, die markdig zum Analysieren von Markdown nutzt. Diese Version enthält mehrere Verbesserungen:
  • Stellt eine genauere Beschreibung eines PowerShell-Cmdlets und seiner Parameter bereit.
  • Erhöhte Leistung – verarbeitet 1000 Markdown-Dateien in Sekunden
  • Erstellt ein Objektmodell der Hilfedatei, die Sie im Arbeitsspeicher bearbeiten können.
  • Stellt Cmdlets bereit, die Sie verketten können, um komplexe Vorgänge auszuführen.
  • Definiert ein neues Markdown-Schema, das alle Elemente enthält, die für Get-Helperforderlich sind, sowie Informationen, die zuvor nicht verfügbar waren.
  • Stellen Sie die automatische Konvertierung vorhandener Markdown -Objekte (mit dem alten Schema) in neue Objekte bereit, sodass Sie in neue Markdown-, YAML- oder MAML-Dateien exportieren können.