Condividi tramite


ConvertFrom-Markdown

Convertire il contenuto di una stringa o di un file in un oggetto MarkdownInfo.

Sintassi

PathParamSet (impostazione predefinita).

ConvertFrom-Markdown
    [-Path] <String[]>
    [-AsVT100EncodedString]
    [<CommonParameters>]

LiteralParamSet

ConvertFrom-Markdown
    -LiteralPath <String[]>
    [-AsVT100EncodedString]
    [<CommonParameters>]

InputObjParamSet

ConvertFrom-Markdown
    -InputObject <PSObject>
    [-AsVT100EncodedString]
    [<CommonParameters>]

Descrizione

Questo cmdlet converte il contenuto specificato in un MarkdownInfo. Quando viene specificato un percorso di file per il parametro Path, il contenuto del file viene convertito. L'oggetto di output ha tre proprietà:

  • La proprietà token dispone dell'albero della sintassi astratta (AST) dell'oggetto convertito
  • La proprietà html ha la conversione HTML dell'input specificato
  • La proprietà VT100EncodedString ha la stringa convertita con sequenze di escape ANSI (VT100) se è stato specificato il parametro AsVT100EncodedString

Questo cmdlet è stato introdotto in PowerShell 6.1.

Esempio

Esempio 1: Convertire un file contenente contenuto Markdown in HTML

ConvertFrom-Markdown -Path .\README.md

Viene restituito l'oggetto MarkdownInfo. La proprietà token di dispone dell'AST del contenuto convertito del file README.md. La proprietà html ha il contenuto convertito HTML del file di README.md.

Esempio 2: Convertire un file contenente contenuto Markdown in una stringa con codifica VT100

ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString

Viene restituito l'oggetto MarkdownInfo. La proprietà token di dispone dell'AST del contenuto convertito del file README.md. La proprietà VT100EncodedString ha il contenuto convertito della stringa con codifica VT100 del file di README.md.

Esempio 3: Convertire l'oggetto di input contenente il contenuto Markdown in una stringa con codifica VT100

Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString

Viene restituito l'oggetto MarkdownInfo. L'oggetto FileInfo da Get-Item viene convertito in una stringa con codifica VT100. La proprietà token di dispone dell'AST del contenuto convertito del file README.md. La proprietà VT100EncodedString ha il contenuto convertito della stringa con codifica VT100 del file di README.md.

Esempio 4: Convertire una stringa contenente contenuto Markdown in una stringa con codifica VT100

"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString

Viene restituito l'oggetto MarkdownInfo. La stringa specificata **Bold text** viene convertita in una stringa con codifica VT100 ed è disponibile in proprietà VT100EncodedString.

Parametri

-AsVT100EncodedString

Specifica se l'output deve essere codificato come stringa con codici di escape VT100.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
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

-InputObject

Specifica l'oggetto da convertire. Quando viene specificato un oggetto di tipo system.String, la stringa viene convertita. Quando viene specificato un oggetto di tipo System.IO.FileInfo, il contenuto del file specificato dall'oggetto viene convertito. Gli oggetti di qualsiasi altro tipo generano un errore.

Proprietà dei parametri

Tipo:PSObject
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

InputObjParamSet
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 un percorso del file da convertire.

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:PSPath, UP

Set di parametri

LiteralParamSet
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Path

Specifica un percorso del file da convertire.

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

PathParamSet
Posizione:0
Obbligatorio:True
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.

Input

PSObject

Output

Microsoft.PowerShell.MarkdownRender.MarkdownInfo