Export-MarkdownCommandHelp
CommandHelp 개체를 markdown 파일로 내보냅니다.
구문
__AllParameterSets
Export-MarkdownCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
이 명령은 CommandHelp 개체를 markdown 파일로 내보냅니다.
메타데이터 매개 변수를 사용하여 markdown 파일에 메타데이터 프런트매터를 추가할 수 있습니다.
cmdlet 또는 Export-MarkdownCommandHelp cmdlet 중 하나를 사용하여 Import-* 개체를 가져올 수 있습니다.
예제
예제 1 - 이전 Markdown 도움말 콘텐츠를 새 형식으로 변환
다음은 .\v1 폴더에서 이전 형식으로 Markdown 도움말을 가져와서 새 형식의 .\v2 폴더로 내보내는 예제입니다.
$chobj = Import-MarkdownCommandHelp -Path .\v1\Export-YamlModuleFile.md
Export-MarkdownCommandHelp -CommandHelp $chobj -OutputFolder .\v2
Directory: D:\Git\PS-Src\platyPS\v2docs\v2
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 5/20/2024 3:33 PM 2892 Export-YamlModuleFile.md
예제 2 - 이전 Markdown 도움말 콘텐츠의 폴더를 새 형식으로 변환
다음은 .\v1 폴더에서 이전 형식으로 Markdown 도움말을 가져와서 새 형식의 .\v1\new 폴더로 내보내는 예제입니다. 필요한 경우 Export-MarkdownCommandHelp 대상 폴더를 만듭니다. 새 markdown 파일은 해당 파일이 속한 모듈의 이름을 딴 폴더에 기록됩니다.
$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
Export-MarkdownCommandHelp -OutputFolder .\v1\new
Directory: D:\Git\PS-Src\platyPS\v2docs\v1\new\Microsoft.PowerShell.PlatyPS
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/26/2024 3:30 PM 3194 Compare-CommandHelp.md
-a--- 8/26/2024 3:30 PM 4282 Export-MamlCommandHelp.md
-a--- 8/26/2024 3:30 PM 6401 Export-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 4874 Export-MarkdownModuleFile.md
-a--- 8/26/2024 3:30 PM 6429 Export-YamlCommandHelp.md
-a--- 8/26/2024 3:30 PM 5601 Export-YamlModuleFile.md
-a--- 8/26/2024 3:30 PM 2724 Import-MamlHelp.md
-a--- 8/26/2024 3:30 PM 3733 Import-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 3870 Import-MarkdownModuleFile.md
-a--- 8/26/2024 3:30 PM 3907 Import-YamlCommandHelp.md
-a--- 8/26/2024 3:30 PM 3477 Import-YamlModuleFile.md
-a--- 8/26/2024 3:30 PM 2088 Measure-PlatyPSMarkdown.md
-a--- 8/26/2024 3:30 PM 4748 New-CommandHelp.md
-a--- 8/26/2024 3:30 PM 8647 New-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 5086 New-MarkdownModuleFile.md
-a--- 8/26/2024 3:30 PM 3080 Test-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 3041 Update-CommandHelp.md
-a--- 8/26/2024 3:30 PM 3981 Update-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 5548 Update-MarkdownModuleFile.md
매개 변수
-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
출력