Freigeben über

Show-Markdown

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Zeigt eine Markdown-Datei 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 vom Terminal gerendert werden (wenn es VT100-Escapesequenzen unterstützt). Dies wird in erster Linie zum Anzeigen von Markdown-Dateien in einem Terminal verwendet. Sie können diese Zeichenfolge auch über den ConvertFrom-Markdown AsVT100EncodedString-Parameter abrufen.

Show-Markdown außerdem hat die Möglichkeit, einen Browser zu öffnen und Ihnen eine gerenderte Version von Markdown 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.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 Markdown-Zeichenfolge, die im Terminal angezeigt wird. Wenn Sie kein unterstütztes Format übergeben, Show-Markdown wird ein Fehler ausgegeben.

Typ:PSObject
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-LiteralPath

Gibt den Pfad zu einer Markdown-Datei an. Im Gegensatz zum Path-Parameter wird der Wert von LiteralPath genau so verwendet, wie er eingegeben wird. 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.

Typ:String[]
Aliase:PSPath, LP
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Path

Gibt den Pfad zu einer Markdown-Datei an, die gerendert werden soll.

Typ:String[]
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-UseBrowser

Kompiliert die Markdown-Eingabe als HTML und öffnet sie in Ihrem Standardbrowser.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

PSObject

String[]

Ausgaben

String