New-MarkdownAboutHelp

  • Odwołanie
Moduł:
platyPS

Generuje nowy plik md tematu tematu na podstawie szablonu.

Składnia

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

Opis

Polecenie New-MarkdownAboutHelp cmdlet generuje plik Markdown, który jest wstępnie wypełniony standardowymi elementami tematu about. Polecenie cmdlet kopiuje szablon MD, zmienia nazwy nagłówków i nazwy pliku zgodnie z parametrem AboutName i osadza plik w katalogu wyznaczonym przez parametr OutputFoler .

Temat informacje można przekonwertować na format Txt. Informacje o tematach muszą być w formacie txt lub aparat pomocy programu PowerShell nie będzie mógł przeanalizować dokumentu. Użyj polecenia cmdlet New-ExternalHelp , aby przekonwertować pliki markdown tematu na pliki txt about topic.

Przykłady

Przykład 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

Utwórz i wyświetl informacje o pliku dla programu PowerShell — informacje o pliku Markdown tematu.

Przykład 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

Utwórz plik Txt tematu programu PowerShell z istniejącego pliku Języka Markdown — informacje.

Parametry

-AboutName

Nazwa tematu o.

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

-OutputFolder

Katalog do utworzenia tematu about in.

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

Dane wejściowe

None

Dane wyjściowe

Object

To polecenie cmdlet zwraca obiekt dla utworzonych plików.

Uwagi

Informacje o tematach należy dodać do pliku cab w celu wykorzystania możliwej do zaktualizowania pomocy.