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 cmdlet New-MarkdownAboutHelp genera un file Markdown prepopolato con gli elementi standard di un argomento About. Il cmdlet copia il modello MD, rinomina intestazioni e nome file in base al parametro AboutName e deposita il file nella directory designata dal parametro OutputFolder.

L'argomento About può essere convertito in formato Txt. Gli argomenti devono essere in formato txt o il motore della Guida di PowerShell non sarà in grado di analizzare il documento. Usare il cmdlet New-ExternalHelp per convertire i file markdown dell'argomento in file txt dell'argomento.

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 il file Txt dell'argomento di PowerShell dal file Markdown About esistente.

Parametri

-AboutName

Nome dell'argomento about.

Tipo:String
Posizione:1
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-OutputFolder

Directory in cui creare l'argomento about.

Tipo:String
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly: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.