PlatyPS の概要

PlatyPS は、Get-Helpを使用して表示される PowerShell ヘルプを作成するための主要なツールです。 PowerShell ヘルプ ファイルは、Microsoft Assistance Markup Language (MAML) と呼ばれる XML 形式で格納されます。 PlatyPSを する前は、ヘルプ ファイルは複雑なツール チェーンを使用して手動で作成されていました。 Markdown は、Visual Studio Codeを含む多くのエディターでサポートされ、簡単に作成できるオープンソース コミュニティで広く使用されています。 PlatyPS を使用すると、Markdown でヘルプ ファイルを記述し、MAML に変換できるため、プロセスが簡略化されます。

PlatyPS には 2 つのメジャー バージョンがあります。

• platyPS v0.14.2 は、Markdown 形式の PowerShell ヘルプ ファイルの作成に使用される PlatyPS の現在のバージョンです。
• Microsoft.PowerShell.PlatyPS v1.0.0-preview1 は、PlatyPS の新しいバージョンです。 このバージョンは、Markdown を解析するために markdig 活用した C# での完全な書き換えです。 このリリースには、いくつかの機能強化が含まれています。
  • PowerShell コマンドレットとそのパラメーターのより正確な説明を提供します
  • パフォーマンスの向上 - 1000s の Markdown ファイルを秒単位で処理
  • メモリ内で操作できるヘルプ ファイルのオブジェクト モデルを作成します。
  • 複雑な操作を実行するために連結できるコマンドレットを提供します
  • Get-Helpに必要なすべての要素と、以前に使用できなかった情報を含む新しい Markdown スキーマを定義します。
  • 既存の Markdown を (古いスキーマを使用して) 新しいオブジェクトに自動変換し、新しい Markdown、YAML、または MAML にエクスポートできるようにします。