共用方式為

PlatyPS 概觀

  • 發行項

PlatyPS 是使用 Get-Help顯示之 PowerShell 說明的主要工具。 PowerShell 說明檔會以 XML 格式儲存，稱為 Microsoft協助標記語言 （MAML）。 在 PlatyPS之前，會使用複雜的工具鏈來手動撰寫說明檔。 Markdown 在開放原始碼社群中廣泛使用，許多編輯器支援這些編輯器，包括 Visual Studio Code，以及更容易撰寫。 PlatyPS 可讓您在 Markdown 中撰寫說明檔，然後轉換成 MAML，藉此簡化程式。

PlatyPS 有兩個主要版本。

  • platyPS v0.14.2 是目前版本的 PlatyPS，用來以 Markdown 格式建立 PowerShell 說明檔案。
  • Microsoft.PowerShell.PlatyPS v1.0.0-preview1 是新版本的 PlatyPS。 此版本是在 C# 中完整重寫，利用 markdig 剖析 Markdown。 此版本包含數項改善：
    • 提供 PowerShell Cmdlet 及其參數更精確的描述
    • 提高效能 - 以秒為單位處理 1000 個 Markdown 檔案
    • 建立可在記憶體中操作之說明檔的物件模型
    • 提供 Cmdlet，您可以鏈結在一起以執行複雜的作業
    • 定義新的 Markdown 架構，其中包含 Get-Help所需的所有元素，以及先前無法使用的資訊。
    • 提供現有 Markdown 的自動轉換（使用舊架構）到新的物件，讓您能夠匯出至新的 Markdown、YAML 或 MAML。