Condividi tramite

Show-Markdown

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Mostra un file Markdown o una stringa nella console in modo descrittivo usando sequenze di escape VT100 o in un browser tramite HTML.

Sintassi

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -LiteralPath <String[]>
    [-UseBrowser]
    [<CommonParameters>]

Descrizione

Il cmdlet Show-Markdown viene usato per eseguire il rendering di Markdown in un formato leggibile in un terminale o in un browser.

Show-Markdown può restituire una stringa che include le sequenze di escape VT100 di cui esegue il rendering il terminale (se supporta le sequenze di escape VT100). Viene usato principalmente per visualizzare i file Markdown in un terminale. È anche possibile ottenere questa stringa tramite il ConvertFrom-Markdown specificando il parametro AsVT100EncodedString.

Show-Markdown ha anche la possibilità di aprire un browser e visualizzare una versione di cui è stato eseguito il rendering di Markdown. Esegue il rendering di Markdown trasformandolo in HTML e aprendo il file HTML nel browser predefinito.

È possibile modificare il modo in cui Show-Markdown esegue il rendering di Markdown in un terminale usando Set-MarkdownOption.

Questo cmdlet è stato introdotto in PowerShell 6.1.

Esempio

Esempio 1: Esempio semplice che specifica un percorso

Show-Markdown -Path ./README.md

Esempio 2: Esempio semplice che specifica una stringa

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

Esempio 2: Apertura di Markdown in un browser

Show-Markdown -Path ./README.md -UseBrowser

Parametri

-InputObject

Stringa Markdown che verrà visualizzata nel terminale. Se non si passa un formato supportato, Show-Markdown genererà un errore.

Tipo:PSObject
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-LiteralPath

Specifica il percorso di un file Markdown. A differenza del parametro Path, il valore di LiteralPath viene usato esattamente come viene tipizzato. Nessun carattere viene interpretato come caratteri jolly. Se il percorso include caratteri di escape, racchiuderlo tra virgolette singole. Le virgolette singole indicano a PowerShell di non interpretare alcun carattere come sequenze di escape.

Tipo:String[]
Alias:PSPath, LP
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Path

Specifica il percorso di un file Markdown di cui eseguire il rendering.

Tipo:String[]
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:True

-UseBrowser

Compila l'input Markdown come HTML e lo apre nel browser predefinito.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:False
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

PSObject

String[]

Output

String