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 están escritos en formato de lenguaje de marcado de asistencia de Microsoft (MAML). MAML define un esquema XML para la estructura de los archivos de ayuda.

Hay dos versiones principales de PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 es la versión compatible 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.
• platyPS v0.14.2 es la implementación original de PlatyPS. Esta versión ya no es compatible.

Beneficios de usar PlatyPS

Antes de PlatyPS, los archivos de ayuda se escribían a mano con ayuda limitada de las herramientas y editores existentes. PlatyPS simplifica el proceso al permitirle escribir los archivos de ayuda en Markdown y luego convertirlos a MAML.

Markdown es fácil de aprender, se usa ampliamente en la comunidad de código abierto y es compatible con muchos editores, incluido Visual Studio Code. Markdown también es fácil de convertir a otros formatos como HTML y PDF. Puede utilizar estos archivos Markdown para crear archivos de ayuda MAML y para crear páginas HTML para un sitio web.

Introducción a PlatyPS

Antes de empezar a trabajar con PlatyPS, debe comprender los tipos de ayuda admitidos por PowerShell. Para obtener más información, consulte Tipos de ayuda en PowerShell.

La creación de archivos de ayuda con PlatyPS es un proceso de cuatro pasos:

1. Cree archivos de ayuda de Markdown nuevos o actualice los existentes .
2. Edite los archivos de ayuda de Markdown para agregar descripciones y ejemplos.
3. Pruebe los archivos de ayuda de Markdown para asegurarse de que se representan correctamente.
4. Convierta y publique los archivos de ayuda.