Condividi tramite

New-MarkdownAboutHelp

  • Riferimento
Modulo:
platyPS

Genera un nuovo file About Topic MD dal modello.

Sintassi

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

Descrizione

Il New-MarkdownAboutHelp cmdlet genera un file Markdown prepopolato con gli elementi standard di un argomento About. Il cmdlet copia il modello MD, rinomina le intestazioni e il nome del file in base al parametro AboutName e deposita il file nella directory designata dal parametro OutputFoler .

L'argomento About può essere convertito in formato Txt. Le informazioni sugli argomenti devono essere in formato txt o il motore della Guida di PowerShell non sarà in grado di analizzare il documento. Utilizzare il cmdlet New-ExternalHelp per convertire i file markdown about topic in file txt About Topic.

Esempio

Esempio 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

Creare e visualizzare informazioni sui file per PowerShell Informazioni sul file Markdown dell'argomento.

Esempio 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

Creare un file Txt relativo all'argomento di PowerShell dal file Markdown About esistente.

Parametri

-AboutName

Nome dell'argomento about.

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

-OutputFolder

Directory in cui creare l'argomento about.

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

Input

None

Output

Object

Questo cmdlet restituisce un oggetto per i file creati.

Note

Gli argomenti relativi dovranno essere aggiunti a un file CAB per sfruttare la Guida aggiornabile.