PlatyPS 개요

PlatyPSGet-Help사용하여 표시되는 PowerShell 도움말을 만들기 위한 기본 도구입니다. PowerShell 도움말 파일은 MAML( Microsoft Assistance Markup Language ) 형식으로 작성됩니다. MAML은 도움말 파일의 구조에 대한 XML 스키마를 정의합니다.

PlatyPS에는 두 가지 주요 버전이 있습니다.

• Microsoft.PowerShell.PlatyPS v1.0.1은 지원되는 PlatyPS 버전입니다. 이 버전은 Markdown 구문 분석용 markdig 활용하는 C#의 완전한 다시 쓰기입니다. 이 릴리스에는 다음과 같은 몇 가지 개선 사항이 포함되어 있습니다.
  • PowerShell cmdlet 및 해당 매개 변수에 대한 보다 정확한 설명을 제공합니다.
  • 성능 향상 - Markdown 파일 1000초 처리(초)
  • 메모리에서 조작할 수 있는 도움말 파일의 개체 모델을 만듭니다.
  • 복잡한 작업을 수행하기 위해 함께 연결할 수 있는 cmdlet을 제공합니다.
  • Get-Help데 필요한 모든 요소와 이전에 사용할 수 없었던 정보를 포함하는 새 Markdown 스키마를 정의합니다.
  • 기존 Markdown(이전 스키마 사용)을 새 개체로 자동 변환하여 새 Markdown, YAML 또는 MAML로 내보낼 수 있도록 합니다.
• platyPS v0.14.2는 PlatyPS의 원래 구현입니다. 이 버전은 더 이상 지원되지 않습니다.

PlatyPS 사용의 이점

PlatyPS 이전에는 도움말 파일이 기존 도구와 편집기의 제한된 도움으로 손으로 작성되었습니다. PlatyPS 는 Markdown으로 도움말 파일을 작성한 다음 MAML로 변환할 수 있도록 하여 프로세스를 단순화합니다.

Markdown 은 배우기 쉽고 오픈 소스 커뮤니티에서 널리 사용되며 Visual Studio Code를 비롯한 많은 편집기에서 지원됩니다. Markdown은 HTML 및 PDF와 같은 다른 형식으로 쉽게 변환할 수도 있습니다. 이러한 Markdown 파일을 사용하여 MAML 도움말 파일을 만들고 웹 사이트에 대한 HTML 페이지를 만들 수 있습니다.

PlatyPS 시작하기

PlatyPS를 시작하기 전에 PowerShell에서 지원하는 도움말 유형을 이해해야 합니다. 자세한 내용은 PowerShell의 도움말 유형을 참조하세요.

PlatyPS로 도움말 파일을 만드는 것은 4단계 프로세스입니다.

1. 새 Markdown 도움말 파일을 만들거나 기존 Markdown 도움말 파일을 업데이트합니다.
2. Markdown 도움말 파일을 편집 하여 설명과 예제를 추가합니다.
3. Markdown 도움말 파일을 테스트 하여 올바르게 렌더링되는지 확인합니다.
4. 도움말 파일을 변환하고 게시합니다.