Merge-MarkdownHelp

Ссылка

Модуль:: platyPS

Объедините несколько версий Markdown одного командлета в один файл Markdown.

Синтаксис

Merge-MarkdownHelp
     [-Path] <String[]>
     [-OutputPath] <String>
     [-Encoding <Encoding>]
     [-ExplicitApplicableIfAll]
     [-Force]
     [[-MergeMarker] <String>]
     [<CommonParameters>]

Описание

Похожие модули или разные версии одного и того же модуля часто содержат повторяющееся содержимое.

Merge-MarkdownHelp объединяет несколько файлов Markdown в один файл Markdown. В нем используется applicable: поле метаданных yaml для определения применимых версий или тегов. Он действует на двух уровнях: для всего командлета и для отдельных параметров.

Полученный markdown содержит applicable: теги, а также все содержимое исходных файлов Markdown. Повторяющееся содержимое просто игнорируется. Содержимое, уникальное для каждого файла, объединяется с помощью маркеров слияния, за которым следует разделенный запятыми список применимых тегов. Маркер слияния — это строка текста, которая выступает в качестве маркера для описания объединенного содержимого. Текст маркера слияния по умолчанию состоит из трех восклицательных знака !! однако его можно изменить на любой соответствующий текст с помощью флага -MergeMarker .

Примеры

Пример 1

Командлет Test-CsPhoneBootstrap.md входит в состав Lync Server 2010 и Lync Server 2013. Большая часть содержимого дублируется, поэтому нам нужен один файл для командлета с уникальным содержимым, объединенным из каждого отдельного файла.

Merge-MarkdownHelp -Path @('Lync Server 2010\Test-CsPhoneBootstrap.md', 'Lync Server 2013\Test-CsPhoneBootstrap.md') -OutputPath lync

Итоговый файл будет находиться по адресу lync\Test-CsPhoneBootstrap.md.

Параметры

-Encoding

Задает кодировку символов для внешнего файла справки. Укажите объект System.Text.Encoding . Подробные сведения см. в статье О шифровании символов.

Type:	Encoding
Position:	Named
Default value:	UTF8 without BOM
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExplicitApplicableIfAll

Всегда записывайте полный список применимых тегов. По умолчанию командлеты и параметры, присутствующие во всех вариантах, не получают тег приложения.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Указывает, что этот командлет перезаписывает существующий файл с тем же именем.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MergeMarker

Строка, используемая в качестве индикатора текста слияния. Список применимых тегов будет включен после маркера

Type:	String
Position:	3
Default value:	'!!! '
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputPath

Указывает путь к папке, в которой этот командлет создает объединенные файлы справки Markdown.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Задает массив путей к файлам или папкам Markdown. Этот командлет создает объединенную справку Markdown на основе этих файлов и папок.

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

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

String[]

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

FileInfo[]

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