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 escritos no formato MAML (Microsoft Assistance Markup Language ). MAML define um esquema XML para a estrutura de arquivos de ajuda.

Existem duas versões principais do PlatyPS.

• Microsoft.PowerShell.PlatyPS v1.0.1 é a versão suportada 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.
• platyPS v0.14.2 é a implementação original do PlatyPS. Esta versão não é mais suportada.

Benefícios do uso de PlatyPS

Antes do PlatyPS, os arquivos de ajuda eram escritos à mão com ajuda limitada de ferramentas e editores existentes. PlatyPS simplifica o processo, permitindo que você escreva os arquivos de ajuda em Markdown e, em seguida, convertê-lo para MAML.

Markdown é fácil de aprender, amplamente utilizado na comunidade de código aberto e suportado por muitos editores, incluindo Visual Studio Code. Markdown também é fácil de converter para outros formatos, como HTML e PDF. Você pode usar esses arquivos Markdown para criar arquivos de ajuda MAML e para criar páginas HTML para um site.

Introdução ao PlatyPS

Antes de começar a usar o PlatyPS, você deve entender os tipos de ajuda suportados pelo PowerShell. Para obter mais informações, consulte Tipos de ajuda no PowerShell.

Criar arquivos de ajuda com PlatyPS é um processo de quatro etapas:

1. Crie novos arquivos de ajuda do Markdown ou atualize os existentes .
2. Edite os arquivos de ajuda Markdown para adicionar descrições e exemplos.
3. Teste os arquivos de ajuda do Markdown para garantir que eles sejam renderizados corretamente.
4. Converta e publique os arquivos de ajuda.