通过

Export-MarkdownModuleFile

模块:
Microsoft.PowerShell.PlatyPS Module

将 ModuleFileInfo 对象导出到 markdown 文件。

语法

__AllParameterSets 

Export-MarkdownModuleFile
    [-ModuleFileInfo] <ModuleFileInfo[]>
    [-Encoding <Encoding>]
    [-Force]
    [-Metadata <hashtable>]
    [-OutputFolder <string>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

此命令将 ModuleFileInfo 对象导出到 markdown 文件。 可以使用 Metadata 参数将元数据 frontmatter 添加到 markdown 文件。 可以使用 cmdlet 获取 Import-MarkdownModuleFile 对象。 可以导入以旧格式编写的模块文件，并将其导出到新格式。

示例

示例 1 - 将旧模块文件转换为新格式

在此示例中，ModuleFileInfo 对象，方法是从 .\v1 文件夹中导入模块 Markdown 文件。 然后，该对象将使用 Export-MarkdownModuleFile以新格式导出到 Markdown 文件。

Import-MarkdownModuleFile -Path .\v1\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md |
    Export-MarkdownModuleFile -OutputFolder .\v1\new\Microsoft.PowerShell.PlatyPS -Force

    Directory: D:\Git\PS-Src\platyPS\v2docs\v1\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:38 PM           2716 Microsoft.PowerShell.PlatyPS.md

参数

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Encoding

写入 markdown 文件时要使用的编码。 如果未指定任何值，则编码默认为 $OutputEncoding 首选项变量的值。

参数属性

类型:Encoding
默认值:False
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Force

使用 Force 参数覆盖输出文件（如果已存在）。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Metadata

要添加到 markdown 文件的 frontmatter 的元数据。 元数据是一个哈希表，可在其中指定要添加到 frontmatter 的键和值对。 新键名称将添加到现有 frontmatter。 覆盖现有键的值。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ModuleFileInfo

要导出到 markdown 文件的 ModuleFileInfo 对象。 此对象由 Import-MarkdownModuleFile cmdlet 创建。

参数属性

类型:

Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-OutputFolder

保存 markdown 文件的文件夹。 如果此文件夹不存在，则创建一个。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-WhatIf

在仅报告将发生的情况而不执行作的模式下运行命令。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

Microsoft.PowerShell.PlatyPS.ModuleFileInfo

输出

FileInfo