Export-MarkdownModuleFile

模組:

Microsoft.PowerShell.PlatyPS Module

將 ModuleFileInfo 對象匯出至 markdown 檔案。

語法

__AllParameterSets

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

Description

此命令會將 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的索引鍵和值組。 新的索引鍵名稱會新增至現有的前端。 會覆寫現有索引鍵的值。

參數屬性

類型:	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

相關連結

• Import-MarkdownModuleFile