Show-Markdown
Zeigt eine Markdowndatei oder -zeichenfolge in der Konsole auf benutzerfreundliche Weise mithilfe von VT100-Escapesequenzen oder in einem Browser mit HTML an.
Syntax
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Beschreibung
Das Show-Markdown
Cmdlet wird verwendet, um Markdown in einem lesbaren Format entweder in einem Terminal oder in einem Browser zu rendern.
Show-Markdown
kann eine Zeichenfolge zurückgeben, die die VT100-Escapesequenzen enthält, die das Terminal rendert (wenn es VT100-Escapesequenzen unterstützt). Dies wird hauptsächlich zum Anzeigen von Markdowndateien in einem Terminal verwendet. Sie können diese Zeichenfolge auch über die abrufen, ConvertFrom-Markdown
indem Sie den Parameter AsVT100EncodedString angeben.
Show-Markdown
verfügt auch über die Möglichkeit, einen Browser zu öffnen und Ihnen eine gerenderte Version des Markdowns anzuzeigen. Das Markdown wird gerendert, indem es in HTML umgewandelt und die HTML-Datei in Ihrem Standardbrowser geöffnet wird.
Sie können ändern, wie Show-Markdown
Markdown in einem Terminal gerendert wird, indem Sie verwenden Set-MarkdownOption
.
Dieses Cmdlet wurde in PowerShell 6.1 eingeführt.
Beispiele
Beispiel 1: Einfaches Beispiel zum Angeben eines Pfads
Show-Markdown -Path ./README.md
Beispiel 2: Einfaches Beispiel zum Angeben einer Zeichenfolge
@"
# Show-Markdown
## Markdown
You can now interact with Markdown via PowerShell!
*stars*
__underlines__
"@ | Show-Markdown
Beispiel 2: Öffnen von Markdown in einem Browser
Show-Markdown -Path ./README.md -UseBrowser
Parameter
-InputObject
Eine Markdownzeichenfolge, die im Terminal angezeigt wird. Wenn Sie kein unterstütztes Format übergeben, Show-Markdown
wird ein Fehler ausgegeben.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Gibt den Pfad zu einer Markdowndatei an. Im Gegensatz zum Path-Parameter wird der Wert des LiteralPath-Parameters genau so verwendet, wie er eingegeben wurde. Es werden keine Zeichen als Platzhalter interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen weisen PowerShell an, keine Zeichen als Escapesequenzen zu interpretieren.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Gibt den Pfad zu einer markdown-Datei an, die gerendert werden soll.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-UseBrowser
Kompiliert die Markdowneingabe als HTML und öffnet sie in Ihrem Standardbrowser.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Eingaben
String[]