Visão geral do PlatyPS

PlatyPS é a principal ferramenta para criar a ajuda do PowerShell exibida usando Get-Help. Os arquivos de ajuda do PowerShell são armazenados em um formato XML conhecido como MAML (Microsoft Assistance Markup Language). Antes de PlatyPS, os arquivos de ajuda eram criados à mão usando cadeias de ferramentas complexas. markdown é amplamente usado na comunidade de software livre, com suporte de muitos editores, incluindo do Visual Studio Code e mais fácil de criar. PlatyPS simplifica o processo permitindo que você escreva os arquivos de ajuda no Markdown e depois convertido em MAML.

Há duas versões principais do PlatyPS.

• platyPS v0.14.2 é a versão atual do PlatyPS usada para criar arquivos de ajuda do PowerShell no formato Markdown.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 é a nova versão do PlatyPS. Esta versão é uma reescrita completa em C# aproveitando de markdig para analisar Markdown. Esta versão inclui várias melhorias:
  • Fornece uma descrição mais precisa de um cmdlet do PowerShell e seus parâmetros
  • Aumento do desempenho – processa 1000 arquivos markdown em segundos
  • Cria um modelo de objeto do arquivo de ajuda que você pode manipular na memória
  • Fornece cmdlets que podem ser encadeados para executar operações complexas
  • Define um novo esquema Markdown que inclui todos os elementos necessários para Get-Help, além de informações que estavam indisponíveis anteriormente.
  • Forneça a conversão automática do Markdown existente (usando o esquema antigo) em novos objetos, permitindo que você exporte para o novo Markdown, YAML ou MAML.