Show-Markdown

  • 참조
모듈:
Microsoft.PowerShell.Utility

VT100 이스케이프 시퀀스를 사용하거나 HTML을 사용하는 브라우저에서 친숙한 방법으로 콘솔의 Markdown 파일 또는 문자열을 표시합니다.

Syntax

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

Description

cmdlet Show-Markdown 은 터미널 또는 브라우저에서 사람이 읽을 수 있는 형식으로 Markdown을 렌더링하는 데 사용됩니다.

Show-Markdown 는 터미널이 렌더링하는 VT100 이스케이프 시퀀스를 포함하는 문자열을 반환할 수 있습니다(VT100 이스케이프 시퀀스를 지원하는 경우). 이는 주로 터미널에서 Markdown 파일을 보는 데 사용됩니다. AsVT100EncodedString 매개 변수를 지정하여 이 문자열 ConvertFrom-Markdown 을 가져올 수도 있습니다.

Show-Markdown 또한 브라우저를 열고 렌더링된 버전의 Markdown을 표시할 수 있습니다. Markdown을 HTML로 변환하고 기본 브라우저에서 HTML 파일을 열어서 Markdown을 렌더링합니다.

를 사용하여 Set-MarkdownOption터미널에서 Markdown을 렌더링하는 방법을 Show-Markdown 변경할 수 있습니다.

이 cmdlet은 PowerShell 6.1에서 도입되었습니다.

예제

예제 1: 경로를 지정하는 간단한 예제

Show-Markdown -Path ./README.md

예제 2: 문자열을 지정하는 간단한 예제

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

예제 2: 브라우저에서 Markdown 열기

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

매개 변수

-InputObject

터미널에 표시될 Markdown 문자열입니다. 지원되는 형식 Show-Markdown 으로 전달하지 않으면 오류가 발생합니다.

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

Markdown 파일의 경로를 지정합니다. Path 매개 변수와 달리 LiteralPath의 값은 입력된 대로 정확하게 사용됩니다. 어떤 문자도 야생으로 해석되지 카드. 경로에 이스케이프 문자가 포함된 경우 작은따옴표로 묶습니다. 작은따옴표는 PowerShell에 문자를 이스케이프 시퀀스로 해석하지 않도록 지시합니다.

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

-Path

렌더링할 Markdown 파일의 경로를 지정합니다.

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

-UseBrowser

Markdown 입력을 HTML로 컴파일하고 기본 브라우저에서 엽니다.

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

입력

PSObject

String[]

출력

String