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

Há duas versões principais do PlatyPS.

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

Benefícios de usar o PlatyPS

Antes do PlatyPS, os arquivos de ajuda eram escritos à mão com ajuda limitada de ferramentas e editores existentes. O PlatyPS simplifica o processo, permitindo que você escreva os arquivos de ajuda em Markdown e depois os converta em MAML.

O Markdown é fácil de aprender, amplamente usado na comunidade de software livre e com suporte de muitos editores, incluindo o Visual Studio Code. O 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 criar páginas HTML para um site.

Comece a usar o PlatyPS

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

A criação de arquivos de ajuda com o PlatyPS é um processo de quatro etapas:

1. Crie novos arquivos de ajuda Markdown ou atualize os existentes .
2. Edite os arquivos de ajuda do 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.