Compartir a través de

New-MarkdownAboutHelp

  • Referencia
Módulo:
platyPS

Genera un nuevo archivo About Topic MD a partir de la plantilla.

Syntax

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

Description

El New-MarkdownAboutHelp cmdlet genera un archivo Markdown que se rellena previamente con los elementos estándar de un tema acerca de . El cmdlet copia la plantilla MD, cambia el nombre de los encabezados y el nombre de archivo según el parámetro AboutName y deposita el archivo en el directorio designado por el parámetro OutputFoler .

El tema acerca de se puede convertir al formato Txt. Los temas sobre los temas deben estar en formato txt o el motor de ayuda de PowerShell no podrá analizar el documento. Use el cmdlet New-ExternalHelp para convertir los archivos markdown acerca del tema en archivos txt de About Topic.

Ejemplos

Ejemplo 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

Cree y muestre información de archivo para PowerShell Acerca del archivo Markdown del tema.

Ejemplo 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

Cree un archivo Txt de tema acerca de PowerShell a partir del archivo Markdown About existente.

Parámetros

-AboutName

Nombre del tema sobre .

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

-OutputFolder

Directorio en el que se va a crear el tema sobre .

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

Entradas

None

Salidas

Object

Este cmdlet devuelve un objeto para los archivos creados.

Notas

Los temas sobre deben agregarse a un archivo cab para aprovechar la ayuda actualizable.