Show-Markdown (Microsoft.PowerShell.Utility)

Show-Markdown

Modül:
Microsoft.PowerShell.Utility

Bir Markdown dosyasını veya dizesini, VT100 çıkış dizilerini kullanarak konsolda veya HTML kullanan bir tarayıcıda kolay bir şekilde gösterir.

Sözdizimi

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

Tanım

Show-Markdown cmdlet'i, Markdown'ı bir terminalde veya tarayıcıda insanlar tarafından okunabilir bir biçimde oluşturmak için kullanılır.

Show-Markdown, terminalin oluşturduğu VT100 kaçış dizilerini içeren bir dize döndürebilir (eğer VT100 kaçış dizilerini destekliyorsa). Bu öncelikle Markdown dosyalarını bir terminalde görüntülemek için kullanılır. Bu dizeyi, AsVT100EncodedString parametresini belirterek ConvertFrom-Markdown aracılığıyla da alabilirsiniz.

Show-Markdown ayrıca bir tarayıcı açma ve size Markdown'ın oluşturulmuş bir sürümünü gösterme özelliğine de sahiptir. Markdown'ı HTML'ye dönüştürerek ve HTML dosyasını varsayılan tarayıcınızda açarak işler.

Set-MarkdownOption'u kullanarak Show-Markdown'un bir terminalde Markdown'u oluşturma biçimini değiştirebilirsiniz.

Bu cmdlet PowerShell 6.1'de tanıtıldı.

Örnekler

Örnek 1: Bir yolu belirten basit örnek

Show-Markdown -Path ./README.md

Örnek 2: Bir dize belirten basit örnek

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

Örnek 2: Markdown'ı tarayıcıda açma

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

Parametreler

-InputObject

Terminalde gösterilecek bir Markdown dizesi. Desteklenen bir biçimde aktarmazsanız Show-Markdown bir hata verecektir.

Tip :

PSObject

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

True

Joker karakterleri kabul et:

False

-LiteralPath

Markdown dosyasının yolunu belirtir. Path parametresinden farklı olarak LiteralPath değeri tam olarak yazıldığı gibi kullanılır. Hiçbir karakter joker karakter olarak yorumlanmaz. Yol kaçış karakterleri içeriyorsa, onu tek tırnak işaretleri içine alın. Tek tırnak işaretleri PowerShell'e hiçbir karakteri kaçış dizisi olarak yorumlamamasını söyler.

Tip :

String[]

Takma adlar:

PSPath, LP

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

True

Joker karakterleri kabul et:

False

-Path

İşlenecek Markdown dosyasının yolunu belirtir.

Tip :

String[]

Konum:

0

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

True

Joker karakterleri kabul et:

True

-UseBrowser

Markdown girişini HTML olarak derler ve varsayılan tarayıcınızda açar.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

Girişler

PSObject

Dize[]

Çıkışlar

Dize

İlgili makaleler