Export-YamlCommandHelp
CommandHelp 개체를 YAML 파일로 내보냅니다.
구문
__AllParameterSets
Export-YamlCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
이 명령은 CommandHelp 개체를 Yaml 파일로 내보냅니다.
메타데이터 매개 변수를 사용하여 Yaml 파일에 메타데이터 프런트매터를 추가할 수 있습니다.
cmdlet 또는 Export-YamlCommandHelp cmdlet 중 하나를 사용하여 Import-* 개체를 가져올 수 있습니다.
예제
예제 1 - Markdown 명령 도움말 콘텐츠를 Yaml 형식으로 변환
다음은 .\v1 폴더에서 이전 형식으로 Markdown 도움말을 가져와서 새 형식의 .\v2 폴더로 내보내는 예제입니다.
$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
Export-YamlCommandHelp -OutputFolder .\v2\yaml
Directory: D:\Git\PS-Src\platyPS\v2docs\v2\yaml
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/26/2024 3:56 PM 3535 Compare-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 4776 Export-MamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 8150 Export-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4998 Export-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 6357 Export-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5396 Export-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 3019 Import-MamlHelp.yml
-a--- 8/26/2024 3:56 PM 4235 Import-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4318 Import-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 4391 Import-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3862 Import-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 2325 Measure-PlatyPSMarkdown.yml
-a--- 8/26/2024 3:56 PM 5190 New-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 8335 New-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4697 New-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 3468 Test-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3172 Update-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 3908 Update-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5217 Update-MarkdownModuleFile.yml
매개 변수
-CommandHelp
내보낼 CommandHelp 개체입니다. 파이프라인 또는 Command 매개 변수를 사용하여 CommandHelp 개체를 전달할 수 있습니다.
매개 변수 속성
형식: Microsoft.PowerShell.PlatyPS.Model.CommandHelp [ ]
Default value: None 와일드카드 지원: False DontShow: False
매개 변수 집합
(All)
Position: 0 필수: 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: False 와일드카드 지원: False DontShow: False
매개 변수 집합
(All)
Position: Named 필수: False 파이프라인의 값: False 속성 이름별 파이프라인의 값: False 나머지 인수의 값: False
-Force
Force 매개 변수를 사용하여 출력 파일이 이미 있는 경우 덮어씁니다.
매개 변수 속성
매개 변수 집합
(All)
Position: Named 필수: False 파이프라인의 값: False 속성 이름별 파이프라인의 값: False 나머지 인수의 값: False
markdown 파일의 프런트매터에 추가할 메타데이터입니다. 메타데이터는 프런트매터에 추가할 키와 값 쌍을 지정하는 해시 테이블입니다. 새 키 이름이 기존 프런트매터에 추가됩니다. 기존 키의 값을 덮어씁니다.
형식: Hashtable
Default value: None 와일드카드 지원: False DontShow: False
(All)
Position: Named 필수: False 파이프라인의 값: False 속성 이름별 파이프라인의 값: False 나머지 인수의 값: False
-OutputFolder
markdown 파일이 저장되는 폴더입니다. 폴더가 없는 경우 만들어집니다.
매개 변수 속성
형식: String
Default value: None 와일드카드 지원: False DontShow: False
매개 변수 집합
(All)
Position: Named 필수: False 파이프라인의 값: 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
출력