Show-Markdown
Mostra un file Markdown o una stringa nella console in modo descrittivo usando sequenze di escape VT100 o in un browser tramite HTML.
Sintassi
Path (impostazione predefinita).
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
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.
Proprietà dei parametri
| Tipo: | PSObject |
| Valore predefinito: | None |
| Supporta i caratteri jolly: | False |
| DontShow: | False |
Set di parametri
InputObject
| Posizione: | Named |
| Obbligatorio: | True |
| Valore dalla pipeline: | True |
| Valore dalla pipeline in base al nome della proprietà: | False |
| Valore dagli argomenti rimanenti: | 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 metacaratteri. Se il percorso include caratteri di escape, racchiudilo tra virgolette singole. Le virgolette singole indicano a PowerShell di non interpretare alcun carattere come sequenze di escape.
Proprietà dei parametri
| Tipo: | String[] |
| Valore predefinito: | None |
| Supporta i caratteri jolly: | False |
| DontShow: | False |
| Alias: | PSPath, UP |
Set di parametri
LiteralPath
| Posizione: | Named |
| Obbligatorio: | True |
| Valore dalla pipeline: | False |
| Valore dalla pipeline in base al nome della proprietà: | True |
| Valore dagli argomenti rimanenti: | False |
-Path
Specifica il percorso di un file Markdown di cui eseguire il rendering.
Proprietà dei parametri
| Tipo: | String[] |
| Valore predefinito: | None |
| Supporta i caratteri jolly: | True |
| DontShow: | False |
Set di parametri
Path
| Posizione: | 0 |
| Obbligatorio: | True |
| Valore dalla pipeline: | False |
| Valore dalla pipeline in base al nome della proprietà: | True |
| Valore dagli argomenti rimanenti: | False |
-UseBrowser
Compila l'input Markdown come HTML e lo apre nel browser predefinito.
Proprietà dei parametri
| Tipo: | SwitchParameter |
| Valore predefinito: | False |
| Supporta i caratteri jolly: | False |
| DontShow: | False |
Set di parametri
(All)
| Posizione: | Named |
| Obbligatorio: | False |
| Valore dalla pipeline: | False |
| Valore dalla pipeline in base al nome della proprietà: | False |
| Valore dagli argomenti rimanenti: | False |
CommonParameters
Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.
