共用方式為

New-MarkdownAboutHelp

  • 參考
模組:
platyPS

從範本產生新的 About Topic MD 檔案。

Syntax

New-MarkdownAboutHelp
   [-OutputFolder] <String>
   [[-AboutName] <String>]
   [<CommonParameters>]

Description

Cmdlet New-MarkdownAboutHelp 會產生已預先填入 About Topic 的標準元素的 Markdown 檔案。 Cmdlet 會複製範本 MD、根據 AboutName 參數重新命名標頭和檔案名，並將檔案儲存在 OutputFoler 參數所指定的目錄中。

[關於主題] 可以轉換成 Txt 格式。 關於主題必須採用 txt 格式，否則 PowerShell 說明引擎將無法剖析檔。 使用 New-ExternalHelp Cmdlet，將 About Topic markdown 檔案轉換成 About Topic txt 檔案。

範例

範例 1

PS C:\> New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName TestAboutTopic
PS C:\> Get-ChildItem C:\Test

    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:12 PM           1491 about_TestAboutTopic.md

建立及顯示 PowerShell 關於主題 Markdown 檔案的檔案資訊。

範例 2

PS C:\> New-ExternalHelp -Path C:\Test\ -OutputPath C:\Test


    Directory: C:\Test


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        7/13/2016   2:15 PM           1550 about_TestAboutTopic.help.txt

從現有的 Markdown 關於檔案建立 PowerShell About Topic Txt 檔案。

參數

-AboutName

關於主題的名稱。

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

-OutputFolder

要建立主題的目錄。

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

輸入

None

輸出

Object

此 Cmdlet 會傳回已建立檔案的 物件。

備註

關於的主題必須新增至 cab 檔案，才能利用可更新的說明。