다음을 통해 공유

Update-MarkdownModuleFile

모듈:
Microsoft.PowerShell.PlatyPS Module

Markdown 모듈 파일을 업데이트합니다.

구문

path 

Update-MarkdownModuleFile
    [-Path] <string>
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

literalpath 

Update-MarkdownModuleFile
    [-CommandHelp] <CommandHelp[]>
    -LiteralPath <string>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

이 cmdlet은 Markdown 명령 파일에서 가져온 CommandHelp 개체 정보를 사용하여 Markdown 모듈 파일을 업데이트합니다.

예제

예제 1 - 새 명령 도움말 파일에서 모듈 파일 업데이트

$mdfiles = Measure-PlatyPSMarkdown -Path .\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Update-MarkdownModuleFile -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md

매개 변수

-CommandHelp

CommandHelp는 내보낼 개체를. 파이프라인에서 또는 이 매개 변수를 사용하여 CommandHelp 개체를 전달할 수 있습니다.

매개 변수 속성

형식:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:1
필수:True
파이프라인의 값:True
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Confirm

cmdlet을 실행하기 전에 확인 메시지를 표시합니다.

매개 변수 속성

형식:SwitchParameter
Default value:False
와일드카드 지원:False
DontShow:False
별칭:cf(cf)

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Encoding

markdown 파일을 작성할 때 사용할 인코딩입니다. 값이 지정되지 않은 경우 인코딩은 기본적으로 $OutputEncoding 기본 설정 변수의 값으로 설정됩니다.

매개 변수 속성

형식:Encoding
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Force

Force 매개 변수를 사용하여 출력 파일이 이미 있는 경우 덮어씁니다.

매개 변수 속성

형식:SwitchParameter
Default value:False
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-HelpInfoUri

이 매개 변수를 사용하면 업데이트 가능한 도움말에 사용되는 URI를 지정할 수 있습니다. 기본적으로 cmdlet은 모듈 매니페스트에 지정된 HelpInfoUri를 사용합니다.

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-HelpVersion

이 매개 변수를 사용하면 도움말의 버전을 지정할 수 있습니다. 기본값은 1.0.0.0. 이 버전은 업데이트 가능한 도움말에 사용되는 HelpInfo.xml 파일에 기록됩니다.

매개 변수 속성

형식:Version
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-LiteralPath

하나 이상의 모듈 markdown 파일에 대한 경로를 지정합니다. LiteralPath 값은 입력된 대로 정확하게 사용됩니다. 와일드카드로 해석되는 문자는 없습니다. 경로에 이스케이프 문자가 포함된 경우 작은따옴표로 묶습니다. 작은따옴표는 PowerShell에 문자를 이스케이프 시퀀스로 해석하지 않도록 지시합니다.

자세한 내용은 about_Quoting_Rules참조하세요.

매개 변수 속성

형식:String
Default value:False
와일드카드 지원:False
DontShow:False
별칭:PSPath, Lp 로

매개 변수 집합

literalpath
Position:Named
필수:True
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Locale

이 매개 변수를 사용하면 도움말 파일의 언어 로캘을 지정할 수 있습니다. 기본적으로 cmdlet은 현재 CultureInfo사용합니다. Get-Culture cmdlet을 사용하여 시스템의 현재 문화권 설정을 확인합니다.

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Metadata

markdown 파일의 프런트매터에 추가할 메타데이터입니다. 메타데이터는 프런트매터에 추가할 키와 값 쌍을 지정하는 해시 테이블입니다. 새 키 이름이 기존 프런트매터에 추가됩니다. 기존 키의 값을 덮어씁니다. document type 또는 PlatyPS schema version 키의 값을 덮어쓸 수 없습니다. 이러한 키가 해시 테이블의 경우 cmdlet은 값을 무시하고 경고를 출력합니다.

매개 변수 속성

형식:Hashtable
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-NoBackup

기본적으로 cmdlet은 업데이트하기 전에 원래 Markdown 파일의 백업을 만듭니다. 이 매개 변수를 사용하여 백업 파일 생성을 표시하지 않습니다.

매개 변수 속성

형식:SwitchParameter
Default value:False
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-Path

하나 이상의 모듈 markdown 파일에 대한 경로를 지정합니다.

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

path
Position:0
필수:True
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

-WhatIf

작업을 수행하지 않고 발생하는 작업만 보고하는 모드에서 명령을 실행합니다.

매개 변수 속성

형식:SwitchParameter
Default value:False
와일드카드 지원:False
DontShow:False
별칭:위스콘신

매개 변수 집합

(All)
Position:Named
필수:False
파이프라인의 값:False
속성 이름별 파이프라인의 값:False
나머지 인수의 값:False

CommonParameters

이 cmdlet은 일반적인 매개 변수인 -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction 및 -WarningVariable 매개 변수를 지원합니다. 자세한 내용은 about_CommonParameters를 참조하세요.

입력

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

출력

FileInfo