Vue d’ensemble de PlatyPS

PlatyPS est l’outil principal permettant de créer l’aide PowerShell affichée à l’aide de Get-Help. Les fichiers d’aide PowerShell sont stockés dans un format XML appelé Microsoft Assistance Markup Language (MAML). Avant platyPS, les fichiers d’aide ont été créés manuellement à l’aide de chaînes d’outils complexes. Markdown est largement utilisé dans la communauté open source, pris en charge par de nombreux éditeurs, notamment Visual Studio Codeet plus facile à créer. PlatyPS simplifie le processus en vous permettant d’écrire les fichiers d’aide dans Markdown, puis convertis en MAML.

Il existe deux versions principales de PlatyPS.

• platyPS v0.14.2 est la version actuelle de PlatyPS utilisée pour créer des fichiers d’aide PowerShell au format Markdown.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 est la nouvelle version de PlatyPS. Cette version est une réécriture complète en C# utilisant markdig pour analyser Markdown. Cette version comprend plusieurs améliorations :
  • Fournit une description plus précise d’une applet de commande PowerShell et de ses paramètres
  • Amélioration des performances : traite les 1 000 fichiers Markdown en secondes
  • Crée un modèle objet du fichier d’aide que vous pouvez manipuler en mémoire
  • Fournit des applets de commande que vous pouvez chaîner pour effectuer des opérations complexes
  • Définit un nouveau schéma Markdown qui inclut tous les éléments nécessaires pour Get-Help, ainsi que les informations qui étaient précédemment indisponibles.
  • Fournissez une conversion automatique de Markdown existant (à l’aide de l’ancien schéma) vers de nouveaux objets, ce qui vous permet d’exporter vers de nouveaux Markdown, YAML ou MAML.