Поделиться через

New-MarkdownAboutHelp

  • Ссылка
Модуль:
platyPS

Создает новый файл about Topic MD из шаблона.

Синтаксис

New-MarkdownAboutHelp
   [-OutputFolder] <String>
   [[-AboutName] <String>]
   [<CommonParameters>]

Описание

Командлет New-MarkdownAboutHelp создает файл Markdown, предварительно заполненный стандартными элементами раздела about. Командлет копирует шаблон MD, переименовывает заголовки и имя файла в соответствии с параметром AboutName и помещает файл в каталог, указанный параметром OutputFolder.

Раздел о разделе можно преобразовать в формат Txt. Сведения о разделах должны быть в формате txt, или подсистема справки PowerShell не сможет проанализировать документ. Используйте командлет New-ExternalHelp, чтобы преобразовать файлы markdown about Topicdown в файлы файла "Раздел".

Примеры

Пример 1

PS C:\> New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName TestAboutTopic
PS C:\> Get-ChildItem C:\Test

    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:12 PM           1491 about_TestAboutTopic.md

Создание и отображение сведений о файле PowerShell About Topic Markdown.

Пример 2

PS C:\> New-ExternalHelp -Path C:\Test\ -OutputPath C:\Test


    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:15 PM           1550 about_TestAboutTopic.help.txt

Создайте файл PowerShell About Topic Txt из существующего файла Markdown About.

Параметры

-AboutName

Имя раздела.

Тип:String
Position:1
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-OutputFolder

Каталог, в который нужно создать раздел.

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

None

Выходные данные

Object

Этот командлет возвращает объект для созданных файлов.

Примечания

Чтобы использовать обновляемую справку, необходимо добавить разделы в cab-файл.