Show-Markdown
Zeigt eine Markdown-Datei oder -Zeichenfolge in der Konsole auf benutzerfreundliche Weise mithilfe von VT100-Escapesequenzen oder in einem Browser mit HTML an.
Syntax
Path (Standard)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
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-MarkdownAsVT100EncodedString-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.
Parametereigenschaften
| Typ: | PSObject |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
InputObject
| Position: | Named |
| Obligatorisch.: | True |
| Wert aus Pipeline: | True |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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 Wildcards interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen signalisieren PowerShell, dass keine Zeichen als Escapesequenzen interpretiert werden sollen.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | PSPath, EP |
Parametersätze
LiteralPath
| Position: | Named |
| Obligatorisch.: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | True |
| Wert aus verbleibenden Argumenten: | False |
-Path
Gibt den Pfad zu einer Markdown-Datei an, die gerendert werden soll.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | True |
| Nicht anzeigen: | False |
Parametersätze
Path
| Position: | 0 |
| Obligatorisch.: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | True |
| Wert aus verbleibenden Argumenten: | False |
-UseBrowser
Kompiliert die Markdown-Eingabe als HTML und öffnet sie in Ihrem Standardbrowser.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.
