通过

PlatyPS 概述

  • 项目

PlatyPS 是创建使用 Get-Help显示的 PowerShell 帮助的主要工具。 PowerShell 帮助文件以称为 Microsoft帮助标记语言（MAML）的 XML 格式存储。 在 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。