Gambaran umum PlatyPS

PlatyPS adalah alat utama untuk membuat bantuan PowerShell yang ditampilkan menggunakan Get-Help. File bantuan PowerShell disimpan dalam format XML yang dikenal sebagai Bahasa Markup Bantuan Microsoft (MAML). Sebelum PlatyPS, file bantuan dibuat dengan tangan menggunakan rantai alat yang kompleks. Markdown banyak digunakan di komunitas sumber terbuka, didukung oleh banyak editor termasuk Visual Studio Code, dan lebih mudah ditulis. PlatyPS menyederhanakan proses dengan memungkinkan Anda menulis file bantuan di Markdown lalu dikonversi ke MAML.

Ada dua versi utama PlatyPS.

• platyPS v0.14.2 adalah versi PlatyPS saat ini yang digunakan untuk membuat file bantuan PowerShell dalam format Markdown.
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 adalah versi baru PlatyPS. Versi ini adalah penulisan ulang lengkap di C# yang memanfaatkan markdig untuk mengurai Markdown. Rilis ini mencakup beberapa peningkatan:
  • Memberikan deskripsi yang lebih akurat tentang cmdlet PowerShell dan parameternya
  • Peningkatan performa - memproses 1000 file Markdown dalam hitungan detik
  • Membuat model objek file bantuan yang dapat Anda manipulasi dalam memori
  • Menyediakan cmdlet yang dapat Anda rantai bersama untuk melakukan operasi yang kompleks
  • Menentukan skema Markdown baru yang mencakup semua elemen yang diperlukan untuk Get-Help, ditambah informasi yang sebelumnya tidak tersedia.
  • Berikan konversi otomatis Markdown yang ada (menggunakan skema lama) ke objek baru, memungkinkan Anda untuk mengekspor ke Markdown, YAML, atau MAML baru.