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 Microsoft Assistance Markup Language (MAML). Antes de PlatyPS, os arquivos de ajuda eram criados manualmente usando cadeias de ferramentas complexas. Markdown é amplamente utilizado na comunidade de código aberto, suportado por muitos editores, incluindo Visual Studio Codee mais fácil de criar. PlatyPS simplifica o processo, permitindo que você escreva os arquivos de ajuda em Markdown e, em seguida, convertido para MAML.

Existem duas versões principais do PlatyPS.

• platyPS v0.14.2 é a versão atual do PlatyPS que é 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 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
  • Maior desempenho - processa 1000s de arquivos Markdown em segundos
  • Cria um modelo de objeto do arquivo de ajuda que você pode manipular na memória
  • Fornece cmdlets que você pode encadear 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 não estavam disponíveis anteriormente.
  • Forneça conversão automática de Markdown existente (usando o esquema antigo) para novos objetos, permitindo que você exporte para novos Markdown, YAML ou MAML.