Обзор PlatyPS

PlatyPS — это основное средство для создания справки PowerShell, отображаемой с помощью Get-Help. Файлы справки PowerShell хранятся в формате XML, известном как язык разметки microsoft help markup (MAML). До PlatyPS файлы справки были созданы с помощью сложных цепочек инструментов. Markdown широко используется в сообществе с открытым кодом, поддерживаемым многими редакторами, включая Visual Studio Codeи проще создавать. PlatyPS упрощает процесс, позволяя записывать файлы справки в Markdown, а затем преобразовать в MAML.

Существует две основные версии PlatyPS.

• platyPS версии 0.14.2 — текущая версия PlatyPS, используемая для создания файлов справки PowerShell в формате Markdown.
• Microsoft.PowerShell.PlatyPS версии 1.0.0-preview1 — это новая версия PlatyPS. Эта версия представляет собой полную перезапись в C#, используя markdig для синтаксического анализа Markdown. Этот выпуск включает несколько улучшений:
  • Предоставляет более точное описание командлета PowerShell и его параметров
  • Повышенная производительность — обрабатывает 1000-х файлов Markdown в секундах
  • Создает объектную модель файла справки, который можно управлять в памяти
  • Предоставляет командлеты, которые можно объединить для выполнения сложных операций
  • Определяет новую схему Markdown, содержащую все элементы, необходимые для Get-Help, плюс сведения, которые ранее были недоступны.
  • Предоставьте автоматическое преобразование существующего Markdown (с помощью старой схемы) в новые объекты, что позволяет экспортировать в новые Markdown, YAML или MAML.