New-MarkdownModuleFile

Модуль:
Microsoft.PowerShell.PlatyPS Module

Создает файл модуля Markdown для модуля PowerShell.

Синтаксис

__AllParameterSets 

New-MarkdownModuleFile
    -OutputFolder <string>
    [-CommandHelp <CommandHelp[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Описание

Эта команда создает файл модуля Markdown для модуля PowerShell. Файл модуля содержит метаданные модуля и список всех команд с описанием их синопсиса. Этот файл можно использовать в качестве целевой страницы модуля в наборе документации. Метаданные модуля используются Export-MamlCommandHelp для создания файла справки MAML для модуля.

Примеры

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

$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    New-MarkdownModuleFile -OutputFolder .\v2 -Force

    Directory: D:\Docs\v2\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

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

$newMarkdownCommandHelpSplat = @{
    CommandHelp  = Get-Command -Module Microsoft.PowerShell.PlatyPS | New-CommandHelp
    OutputFolder = '.\new'
    Force        = $true
}
New-MarkdownModuleFile @newMarkdownCommandHelpSplat

    Directory: D:\Docs\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

Параметры

-CommandHelp

Объекты commandHelp , которые будут включены в файл модуля. Объект CommandHelp можно передать в конвейере или с помощью параметра команды .

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

Тип:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

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

-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

-OutputFolder

Указывает расположение, в котором записывается файл модуля Markdown. Командлет создает папку для каждого модуля на основе обрабатываемого объекта CommandHelp CommandHel p.

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

Тип: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

CommonParameters

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

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

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

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

FileInfo