New-MarkdownCommandHelp

Модуль:

Microsoft.PowerShell.PlatyPS Module

Создает файлы справки Markdown для модулей и команд PowerShell.

Синтаксис

__AllParameterSets

New-MarkdownCommandHelp
    -OutputFolder <string>
    [-CommandInfo <CommandInfo[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpUri <string>]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-ModuleInfo <psmoduleinfo[]>]
    [-WithModulePage]
    [-AbbreviateParameterTypename]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Создает файлы справки Markdown для модулей и команд PowerShell.

Примеры

Пример 1. Создание файлов справки Markdown для модуля

$newMarkdownCommandHelpSplat = @{
    ModuleInfo = Get-Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Пример 2. Создание файлов справки Markdown из списка команд

$newMarkdownCommandHelpSplat = @{
    CommandInfo = Get-Command -Module Microsoft.PowerShell.PlatyPS
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Параметры

-AbbreviateParameterTypename

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

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-CommandInfo

Список одной или нескольких команд для создания справки.

Свойства параметров

Тип:	CommandInfo[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	cf

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Encoding

Кодировка, используемая при создании выходных файлов. Если этот параметр не указан, командлет использует значение, указанное $OutputEncoding.

Свойства параметров

Тип:	Encoding
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Force

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

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HelpInfoUri

Этот параметр позволяет указать универсальный код ресурса (URI), используемый для поддержки обновления. По умолчанию командлет использует HelpInfoUri, указанный в манифесте модуля.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HelpUri

Этот параметр позволяет указать универсальный код ресурса (URI), используемый для веб-справки. По умолчанию командлет использует URI, определенный в атрибуте [CmdletBinding()] для команды.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-HelpVersion

Этот параметр позволяет указать версию справки. Значение по умолчанию — 1.0.0.0. Эта версия записывается в файл HelpInfo.xml, который используется для обновления справки.

Свойства параметров

Тип:	Version
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Locale

Этот параметр позволяет указать языковой стандарт для файлов справки. По умолчанию командлет использует текущий CultureInfo. Используйте командлет Get-Culture для просмотра текущих параметров языка и региональных параметров в системе.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Metadata

Метаданные, добавляемые в интерфейсный файл markdown. Метаданные — это хэш-список, в котором указываются пары "ключ и значение", добавляемые в frontmatter. Новые имена ключей добавляются в существующий интерфейсный элемент. Значения существующих ключей перезаписываются. Нельзя перезаписать значения ключей document type или PlatyPS schema version. Если эти ключи присутствуют в хэш-таблицы, командлет игнорирует значения и выводит предупреждение.

Свойства параметров

Тип:	Hashtable
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ModuleInfo

Список одного или нескольких модулей для создания справки. Командлет создает файлы справки Markdown для всех команд в модуле. Командлет создает папку, соответствующую имени модуля в выходном расположении. Все файлы Markdown записываются в папку модуля.

Свойства параметров

Тип:	PSModuleInfo[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-OutputFolder

Указывает расположение, в котором записываются файлы справки Markdown. Командлет создает папку для каждого обрабатываемого модуля. Если целевая команда не связана с модулем, командлет создает файл Markdown в корне выходной папки.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WhatIf

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

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	wi

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WithModulePage

По умолчанию этот командлет создает только файлы Markdown для команд. При использовании этого параметра командлет создает файл Markdown для модуля. Этот файл Markdown содержит список всех команд в модуле и метаданных, используемых для создания файла HelpInfo.xml.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

CommandInfo

PSModuleInfo

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

FileInfo

Связанные ссылки

• Export-MarkdownCommandHelp