Обзор PlatyPS

PlatyPS — это основное средство для создания справки PowerShell, отображаемой с помощью Get-Help. Файлы справки PowerShell записываются в формате языка разметки Microsoft Assistance Markup Language (MAML). MAML определяет XML-схему для структуры файлов справки.

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

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

Преимущества использования PlatyPS

До появления PlatyPS, файлы справки создавались от руки с ограниченной помощью существующих инструментов и редакторов. PlatyPS упрощает процесс, позволяя записывать файлы справки в Markdown, а затем конвертировать их в MAML.

Markdown прост в освоении, широко используется в сообществе разработчиков с открытым исходным кодом и поддерживается многими редакторами, включая Visual Studio Code. Markdown также легко конвертировать в другие форматы, такие как HTML и PDF. Эти файлы Markdown можно использовать для создания файлов справки MAML и HTML-страниц для веб-сайта.

Начать работу с PlatyPS

Прежде чем приступить к работе с PlatyPS, необходимо ознакомиться с типами справки, поддерживаемыми PowerShell. Дополнительные сведения см. в статье Типы справки в PowerShell.

Создание файлов справки с помощью PlatyPS состоит из четырех этапов:

1. Создавайте новые или обновляйте существующие файлы справки Markdown.
2. Отредактируйте файлы справки Markdown , добавив в них описания и примеры.
3. Проверьте файлы справки Markdown , чтобы убедиться, что они отображаются правильно.
4. Конвертируйте и опубликуйте файлы справки.