Show-Markdown

  • Başvuru
Modül:
Microsoft.PowerShell.Utility

Konsoldaki bir Markdown dosyasını veya dizesini VT100 kaçış dizilerini kullanarak kolay bir şekilde veya HTML kullanan bir tarayıcıda gösterir.

Syntax

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

Description

Show-Markdown Cmdlet, Markdown'ı bir terminalde veya tarayıcıda okunabilir bir biçimde işlemek için kullanılır.

Show-Markdown terminalin işlediği VT100 kaçış dizilerini içeren bir dize döndürebilir (VT100 kaçış dizilerini destekliyorsa). Bu, birincil olarak terminalde Markdown dosyalarını görüntülemek için kullanılır. Bu dizeyiConvertFrom-Markdown, AsVT100EncodedString parametresini belirterek aracılığıyla da alabilirsiniz.

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

kullanarak Set-MarkdownOptionbir terminalde Markdown'ın nasıl Show-Markdown işlenme şeklini değiştirebilirsiniz.

Bu cmdlet PowerShell 6.1'de kullanıma sunulmuştur.

Örnekler

Örnek 1: Yol belirtmeye yönelik basit örnek

Show-Markdown -Path ./README.md

Örnek 2: Dize belirtmeye yönelik basit örnek

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

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

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

Parametreler

-InputObject

Terminalde gösterilecek bir Markdown dizesi. Desteklenen bir biçimde geçirmezseniz, Show-Markdown bir hata gösterir.

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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 yorumlanmamıştır. Yol kaçış karakterleri içeriyorsa, tek tırnak içine alın. Tek tırnak işaretleri PowerShell'e hiçbir karakteri kaçış dizisi olarak yorumlamaması gerektiğini söyler.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-UseBrowser

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Girişler

PSObject

String[]

Çıkışlar

String