다음을 통해 공유

GitHub Codespaces를 사용하여 참가

GitHub에는 소프트웨어를 로컬로 설치하거나 구성하지 않고도 PowerShell 설명서에 기여하는 데 사용할 수 있는 Codespaces 라는 기능이 있습니다. 코드스페이스를 사용하는 경우 팀에서 작성 및 편집에 사용하는 것과 동일한 제작 도구를 얻을 수 있습니다.

브라우저에서 코드스페이스를 사용하여 인터넷을 통해 호스팅되는 VS Code에서 기여할 수 있습니다. VS Code를 로컬로 설치한 경우 해당 코드 영역에도 연결할 수 있습니다.

사용 가능한 도구

Codespace를 사용하여 PowerShell 설명서에 기여하는 경우 편집기에서 이미 사용할 수 있는 도구가 있습니다.

  • Markdown 구문을 확인하기 위한 Markdownlint입니다.
  • 맞춤법 검사를 위한 cSpell입니다.
  • Vale는 문서를 교정하는 데 사용합니다.
  • 플랫폼별 구문을 삽입하고 기여도를 미리 보기 위한 학습 작성 팩 입니다.
  • 필요에 따라 Markdown을 래핑하여 읽기 및 편집을 더 쉽게 하기 위한 리플로 Markdown 확장입니다.
  • 열을 수동으로 정렬할 필요 없이 테이블을 더 읽기 쉽게 만들기 위한 테이블 포맷터 확장입니다.
  • 제목 및 산문의 대/소문자 변환을 위한 change-case 확장 기능입니다.
  • 기록 파일 변경 내용을 검토하기 위한 GitLens 확장명입니다.
  • PowerShell 작성 예제를 상호 작용하기 위한 PowerShell 확장입니다.
  • Markdown에서 문제가 있는 문자를 찾기 위한 Visual Studio Code용 Gremlins 추적기 입니다.

비용

GitHub Codespaces는 매월 최대 120개의 코어 시간을 무료로 사용할 수 있습니다. 월별 사용량은 설명서뿐만 아니라 모든 리포지토리에서 계산됩니다.

가격 책정에 대한 자세한 내용은 GitHub Codespaces에 대한 청구 정보를 참조하세요.

팁 (조언)

컨테이너 및 Docker를 사용하는 것이 편한 경우 PowerShell 설명서 리포지토리에 대해 정의된 devcontainer를 사용하여 동일한 환경을 얻을 수 있습니다. devcontainers 사용과 관련된 비용은 없습니다. 자세한 내용은 Dev Containers 자습서를 참조하세요.

GitHub Codespace 만들기

PowerShell 설명서에 기여하기 위한 GitHub Codespace를 만들려면 다음 단계를 수행합니다.

  1. 브라우저에서 https://github.com/codespaces 엽니다.
  2. 페이지 오른쪽 위에 있는 "새 코드스페이스" 단추를 선택합니다.
  3. "새 코드스페이스 만들기" 페이지에서 "리포지토리 선택" 단추를 선택하고 참여하려는 리포지토리의 이름을 입력합니다(예: MicrosoftDocs/PowerShell-Docs).
  4. 다른 모든 설정을 기본값으로 둡니다.
  5. "코드스페이스 만들기" 단추를 선택합니다.

이러한 단계를 수행한 후 GitHub는 해당 리포지토리에 대한 새 코드스페이스를 만들고 자동으로 설정합니다. 코드스페이스가 준비되면 페이지가 새로 고쳐지고 코드스페이스에 대한 웹 편집기 UI가 표시됩니다. UI는 VS Code를 기반으로 하며 동일한 방식으로 작동합니다.

GitHub Codespace 열기

브라우저에서 GitHub Codespace를 열려면 다음 단계를 수행합니다.

  1. 브라우저에서 https://github.com/codespaces 엽니다.
  2. 페이지에 Codespaces 목록이 표시됩니다. 참여하려는 리포지토리에 대해 만든 코드스페이스를 찾아 선택합니다.

코드스페이스를 선택하면 GitHub가 동일한 창에서 열립니다. 여기에서 기여할 준비가 완료되었습니다.

VS Code에서 GitHub Codespace를 열려면 Visual Studio Code에서 GitHub Codespaces 사용의 단계를 따릅니다.

GitHub Codespace에서 콘텐츠 작성하기

브라우저 또는 VS Code에서 GitHub Codespace를 열면 설명서에 기여하는 프로세스는 동일한 프로세스를 따릅니다.

이 문서의 나머지 부분에는 기여를 작성하거나 편집하는 동안 GitHub Codespace에서 수행할 수 있는 작업의 선택에 대해 설명합니다.

같은 [some text](destination.md)인라인 링크를 같은 [some text][01]참조 링크로 전환하려면 편집기에서 링크 대상을 선택합니다. 그런 다음 다음 중 하나를 수행할 수 있습니다.

  1. 링크 대상을 마우스 오른쪽 버튼으로 클릭하고 컨텍스트 메뉴에서 "리팩터링..."을 선택합니다.
  2. Ctrl+Shift+R을 누릅니다.

두 작업 중 하나를 수행하면 리팩터링 컨텍스트 메뉴가 표시됩니다. 링크에서 (destination.md)를 [def]으로 대체하려면 상황에 맞는 메뉴에서 링크 정의로 추출을 선택하세요. 이름을 입력하여 정의의 이름을 바꿀 수 있습니다.

PowerShell 설명서의 경우 두 자리 숫자 참조 링크 정의(예 [01] : 또는 [31].)를 사용합니다. 문서 및 개념 설명서에 대한 참조 링크 정의만 사용합니다. cmdlet 참조 설명서에서 참조 링크 정의를 사용하지 마세요.

산문 스타일 위반 수정

Codespace에서 문서를 검토하면 처음 열 때와 저장할 때마다 Vale에서 자동으로 문서를 확인합니다. Vale가 스타일 위반을 발견하면 문서에서 색깔 있는 물결선으로 이를 강조 표시합니다.

위반에 대한 자세한 정보를 보려면 마우스로 가리킵니다.

규칙을 설명하는 웹 페이지를 열려면 가리키기 정보에서 규칙의 이름을 선택합니다. 규칙을 열고 해당 구현을 검토하려면 규칙의 파일 이름(끝)을 .yml선택합니다.

규칙이 빠른 수정을 지원하는 경우 "빠른 수정..."을 선택할 수 있습니다. 는 위반에 대한 가리키기 정보에서 상황에 맞는 메뉴에서 선택하여 제안된 수정 사항 중 하나를 적용합니다. 커서가 강조 표시된 문제에 있을 때 규칙이 지원하는 경우, Ctrl+ 키를 눌러 빠른 수정을 적용할 수 있습니다.

규칙이 빠른 수정을 지원하지 않는 경우 규칙의 메시지를 읽고 가능하면 수정합니다. 문제가 무엇인지 잘 모를 경우, PR을 검토할 때 편집자가 제안을 할 수 있습니다.

구문 문제 해결

코드 영역에서 문서를 검토할 때 Markdownlint는 문서를 열 때와 입력할 때 자동으로 문서를 확인합니다. Markdownlint가 구문 오류를 찾으면 문서에서 색상 물결선을 사용하여 강조 표시합니다.

위반에 대한 자세한 정보를 보려면 마우스로 가리킵니다. 규칙을 설명하는 웹 페이지를 열려면 가리키기 정보에서 규칙의 ID를 선택합니다.

규칙이 빠른 수정을 지원하는 경우 "빠른 수정..."을 선택할 수 있습니다. 는 위반에 대한 가리키기 정보에서 상황에 맞는 메뉴에서 선택하여 제안된 수정 사항 중 하나를 적용합니다. 커서가 강조 표시된 문제에 있을 때 규칙이 지원하는 경우, Ctrl+ 키를 눌러 빠른 수정을 적용할 수 있습니다.

규칙이 빠른 수정을 지원하지 않는 경우 규칙의 메시지를 읽고 가능하면 수정합니다. 문제가 무엇인지 잘 모를 경우, PR을 검토할 때 편집자가 제안을 할 수 있습니다.

문서의 모든 구문 위반에 수정 사항을 적용할 수도 있습니다. 이렇게 하려면 명령 팔레트를 열고 .를 입력 Fix all supported markdownlint violations in the document합니다. 입력할 때 명령 팔레트는 사용 가능한 명령을 필터링합니다. "문서에서 지원되는 모든 markdownlint 위반 수정" 명령을 선택합니다. 이렇게 하면 Markdownlint에서 문서를 업데이트하여 빠른 수정이 있는 위반 사항을 해결합니다.

표 서식 지정

Markdown 테이블의 서식을 지정하려면 Markdown의 표에 커서를 놓습니다. 명령 팔레트를 열고 명령을 검색합니다 Table: Format Current . 이 명령을 선택하면 테이블의 Markdown이 업데이트되어 가독성이 향상되도록 테이블을 정렬하고 패딩합니다.

다음과 같이 정의된 테이블을 변환합니다.

| foo | bar | baz |
|:--:|:--|-:|
| a | b | c |

이 내용으로:

|  foo  | bar  | baz  |
| :---: | :--- | ---: |
|   a   | b    |    c |

경고 삽입

이 설명서는 경고를 사용하여 독자에게 더 주목할 만한 정보를 만듭니다.

경고를 삽입하려면 명령 팔레트를 열고 Learn: Alert 명령을 검색할 수 있습니다. 해당 명령을 선택하면 상황에 맞는 메뉴가 열립니다. 추가하려는 경고 유형을 선택합니다. 이렇게 하면 명령이 문서의 커서에 경고의 Markdown을 삽입합니다.

문장 스타일로 제목을 작성하세요.

제목의 대/소문자를 변경하려면, 먼저 제목 수준을 나타내는 선행 # 기호를 제외하고 제목 텍스트를 강조 표시합니다. 텍스트가 강조 표시되면 명령 팔레트를 열고 명령을 검색합니다 Change case sentence . 해당 명령을 선택하면 강조 표시된 텍스트의 대/소문자를 변환합니다.

문서의 모든 텍스트에 대/소문자 구분 명령을 사용할 수도 있습니다.

명령 팔레트 열기

VS Code의 명령 팔레트 를 사용하여 많은 유용한 명령을 실행할 수 있습니다.

UI에서 명령 팔레트를 열려면 위쪽 메뉴 모음에서 "보기"를 선택합니다. 그런 다음 상황에 맞는 메뉴에서 "명령 팔레트..."를 선택합니다.

키보드로 명령 팔레트를 열려면 운영 체제의 키 조합을 누릅니다.

  • Windows 및 Linux: Ctrl+Shift+P
  • macOS: Cmd+Shift+P

기여 미리 보기

기여를 미리 보려면 명령 팔레트를 열고 명령을 검색합니다 Markdown: Open Preview . 해당 명령을 선택하면 VS Code에서 현재 문서의 미리 보기를 엽니다. 미리 보기의 스타일은 Learn 플랫폼과 일치합니다.

비고

미리 보기에서는 사이트 상대 및 상호 참조 링크가 작동하지 않습니다.

콘텐츠를 다시 구성하세요

문서에서 단락의 줄 길이를 제한하려면 단락에 커서를 놓습니다. 그런 다음 명령 팔레트를 열고 명령을 검색합니다 Reflow Markdown . 명령을 선택하면 현재 단락의 줄 길이가 구성된 길이로 업데이트됩니다. 리포지토리의 경우 길이는 99자입니다.

블록 따옴표에 이 명령을 사용하는 경우 재배치할 블록 따옴표의 단락이 빈 줄로 둘러싸여 있는지 확인합니다. 그렇지 않으면 명령은 모든 단락을 함께 다시 배열합니다.

주의

아티클을 편집할 때는 이 명령을 사용하지 마세요. 해당 문서의 줄은 80자를 넘지 않아야 합니다. 현재 리포지토리가 폴더 또는 파일 이름별로 다른 줄 길이를 구성할 수 있는 방법은 없으므로 문서 문서에 대해 리플로가 작동하지 않습니다.

문서의 모든 문제 검토

문서의 모든 구문 및 스타일 규칙 위반을 검토하려면 문제 보기를 엽니다.

UI에서 문제 보기를 열려면 위쪽 메뉴 모음에서 "보기"를 선택합니다. 그런 다음 상황에 맞는 메뉴에서 "문제"를 선택합니다.

키보드로 문제 보기를 열려면 운영 체제의 키 조합을 누릅니다.

  • Windows 및 Linux: Ctrl+Shift+M
  • macOS: Cmd+Shift+M

문제 보기에는 열려 있는 문서에 대한 모든 오류, 경고 및 제안이 표시됩니다. 문서에서 스크롤할 문제를 선택합니다.

형식 또는 텍스트 일치를 통해 문제를 필터링할 수 있습니다.

ms.date 메타데이터 업데이트

문서의 ms.date 메타데이터를 업데이트하려면 명령 팔레트를 열고 Learn: Update "ms.date" Metadata Value 명령을 검색하세요. 명령을 선택하면 메타데이터가 현재 날짜로 업데이트됩니다.

추가 리소스

이 문서에 설명된 작업 및 명령은 VS Code 또는 설치된 확장으로 수행할 수 있는 모든 작업을 다루지 않습니다.

VS Code 사용에 대한 자세한 내용은 다음 문서를 참조하세요.

설치된 확장에 대한 자세한 내용은 해당 설명서를 참조하세요.

  • Last updated on