Introducción a PlatyPS

PlatyPS es la herramienta principal para crear la ayuda de PowerShell que se muestra mediante Get-Help. Los archivos de ayuda de PowerShell se almacenan en un formato XML conocido como lenguaje de marcado de asistencia de Microsoft (MAML). Antes de PlatyPS, los archivos de ayuda se crearon a mano mediante cadenas de herramientas complejas. markdown se usa ampliamente en la comunidad de código abierto, compatible con muchos editores, incluidos Visual Studio Codey más fácil de crear. PlatyPS simplifica el proceso al permitirle escribir los archivos de ayuda en Markdown y, a continuación, convertirlos en MAML.

Hay dos versiones principales de PlatyPS.

• platyPS v0.14.2 es la versión actual de PlatyPS que se usa para crear archivos de ayuda de PowerShell en formato Markdown.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 es la nueva versión de PlatyPS. Esta versión es una reescritura completa en C# aprovechando markdig para analizar Markdown. Esta versión incluye varias mejoras:
  • Proporciona una descripción más precisa de un cmdlet de PowerShell y sus parámetros.
  • Mayor rendimiento: procesa 1000 archivos de Markdown en segundos
  • Crea un modelo de objetos del archivo de ayuda que se puede manipular en la memoria
  • Proporciona cmdlets que puede encadenar para realizar operaciones complejas.
  • Define un nuevo esquema de Markdown que incluye todos los elementos necesarios para Get-Help, además de información que anteriormente no estaba disponible.
  • Proporcione la conversión automática de Markdown existente (mediante el esquema antiguo) a nuevos objetos, lo que le permite exportar a un nuevo Markdown, YAML o MAML.