HoloLens 설명서에 기여
HoloLens 설명서시작합니다. 이 리포지토리 만들거나 편집하는 모든 문서가 대중에게 표시됩니다.
HoloLens 설명서는 Markdig 기능과 함께 GitHub 맛 Markdown을 사용하는 Microsoft Learn에 게시됩니다. 이 리포지토리에서 편집한 콘텐츠는 /hololens
표시되는 스타일이 지정된 페이지로 서식이 지정됩니다.
이 페이지에서는 기여에 대한 기본 단계 및 지침과 Markdown 기본 사항에 대한 링크를 다룹니다. 기여해 주셔서 감사합니다!
리포지토리 이름 | URL |
---|---|
HoloLens | MicrosoftDocs/HoloLens |
혼합 현실 | MicrosoftDocs/혼합 현실 |
VR 매니아 가이드 | MicrosoftDocs/mixed-reality/enthusiast-guide |
참고
Microsoft 직원인 경우 Microsoft 오픈 소스 포털
GitHub 계정을 설정할 때 다음 보안 예방 조치도 권장합니다.
- GitHub 계정대한
강력한 암호를 만듭니다. - 2단계 인증사용하도록 설정합니다.
- 복구 코드 안전한 장소에 저장합니다.
-
공개 프로필 설정업데이트합니다.
- 이름을 설정하고 공개 전자 메일내 전자 메일 주소표시 안 함으로 설정하는 것이 좋습니다.
- 기여하는 Microsoft Learn 문서에 미리 보기가 표시되므로 프로필 사진을 업로드하는 것이 좋습니다.
- 명령줄을 사용하려는 경우 Windows
Git 자격 증명 관리자를 설정하는 것이 좋습니다. 이렇게 하면 기여할 때마다 암호를 입력할 필요가 없습니다.
게시 시스템은 GitHub에 연결되어 있으므로 이러한 단계가 중요합니다. GitHub 별칭을 사용하여 각 문서의 작성자 또는 기여자로 나열됩니다.
다음 워크플로를 사용하여 웹 브라우저에서 GitHub를 통해 기존 문서를
"hololens" 폴더에서 편집하려는 문서로 이동합니다.
오른쪽 위에서 편집 단추(연필 아이콘)를 선택합니다.
그러면 기본
삭제 가능한 분기가 자동으로 분기됩니다. Markdown 기본따라 문서의 내용을 편집합니다.
각 문서의 맨 위에 있는 메타데이터를 업데이트합니다.
- 제목: 문서를 볼 때 브라우저 탭에 표시되는 페이지 제목입니다. 페이지 제목은 SEO 및 인덱싱에 사용되므로 필요한 경우가 아니면 제목을 변경하지 마세요(설명서가 공개되기 전에 덜 중요하지만).
- 설명: 문서의 콘텐츠에 대한 간략한 설명을 작성하여 SEO 및 검색을 향상시킵니다.
- 작성자: 페이지의 기본 소유자인 경우 여기에 GitHub 별칭을 추가합니다.
- ms.author: 페이지의 기본 소유자인 경우 여기에 Microsoft 별칭을 추가합니다(별칭만 @microsoft.com필요 없음).
- ms.date: 페이지에 주요 콘텐츠를 추가하는 경우 날짜를 업데이트하지만 설명, 서식, 문법 또는 맞춤법과 같은 수정 사항은 업데이트하지 않습니다.
- 키워드: 키워드는 SEO(검색 엔진 최적화)를 지원합니다. 쉼표와 공백으로 구분된 키워드를 추가합니다. 이 키워드는 아티클과 관련이 있지만 목록의 마지막 키워드 뒤의 문장 부호는 추가하지 않습니다. 모든 아티클에 적용되는 전역 키워드는 다른 곳에서 관리되므로 추가할 필요가 없습니다.
문서 편집을 완료했으면 아래로 스크롤하여 파일 변경
선택합니다. 다음 페이지에서 끌어오기 요청 만들기를 선택하여 자동으로 생성된 분기를 기본 분기 기본병합합니다.
편집하려는 다음 문서에 대해 위의 단계를 반복합니다.
변경 내용이 기존 아티클의 이름을 바꾸거나 삭제하는 경우 리디렉션을 추가해야 합니다. 이렇게 하면 기존 문서에 대한 링크가 있는 모든 사용자가 올바른 위치에 있습니다. 리디렉션은 리포지토리 루트의 .openpublishing.redirection.json 파일에 의해 관리됩니다.
.openpublishing.redirection.json리디렉션을 추가하려면 redirections
배열에 항목을 추가합니다.
{
"redirections": [
{
"source_path": "hololens/old-article",
"redirect_url": "/base-url/new-article#section-about-old-topic",
"redirect_document_id": false
},
source_path
제거하려는 이전 문서의 상대 리포지토리 경로입니다. 경로가 docset(이 경우hololens
)으로 시작하고.md
파일 확장자를 포함해야 합니다.redirect_url
이전 문서에서 새 아티클에 대한 상대 공용 URL입니다. 리포지토리 경로가 아닌 공용 URL을 참조하므로 이 URL.md
포함되어 있지 않고/
시작합니다.#section
사용하여 새 아티클 내의 섹션에 연결할 수 있습니다. 필요한 경우 여기에서 다른 사이트에 대한 절대 경로를 사용할 수도 있습니다.redirect_document_id
이전 파일에서 문서 ID를 유지할지 여부를 나타냅니다. 기본값은false
. 리디렉션된 아티클에서ms.documentid
특성 값을 유지하려면true
사용합니다. 문서 ID를 유지하면 페이지 보기 및 순위와 같은 데이터가 대상 문서로 전송됩니다. 리디렉션이 주로 이름이 바뀌고 동일한 콘텐츠 중 일부만 다루는 다른 아티클에 대한 포인터가 아닌 경우 이 작업을 수행합니다.
리디렉션을 추가하는 경우 이전 파일도 삭제해야 합니다.
다음 워크플로를 사용하여 웹 브라우저에서 GitHub를 통해 설명서 리포지토리에 새 아티클을
오른쪽 위에 있는
포크 단추를 사용하여 기본 분기인 MicrosoftDocs/hololens의 기본포크를 만듭니다. "hololens" 폴더에서 오른쪽 위에 새 파일 만들기를 선택합니다.
아티클의 페이지 이름을 만들고(공백 대신 하이픈을 사용하고 문장 부호 또는 아포스트로피를 사용하지 않음) ".md"를 추가합니다.
중요
"hololens" 폴더 내에서 새 문서를 만들어야 합니다. 새 파일 이름 줄에서 "/hololens/"를 확인하여 이를 확인할 수 있습니다.
새 페이지의 맨 위에 다음 메타데이터 블록을 추가합니다.
--- title: description: author: ms.author: ms.date: ms.topic: article keywords: ---
기존 문서편집에서 설명한 대로 관련 메타데이터 필드를 입력합니다.
Markdown 기본 사항사용하여 아티클 콘텐츠를 작성합니다.
문서의 맨 아래에 다른 관련 문서에 대한 링크가 있는
## See also
섹션을 추가합니다.완료되면 새 파일커밋을 선택합니다.
새 끌어오기 요청
선택하고 포크의 주 분기를 MicrosoftDocs/hololens기본 병합합니다(화살표가 올바른 대상을 가리키는지 확인).
다음 리소스는 Markdown 언어를 사용하여 설명서를 편집하는 방법을 알아보는 데 도움이 됩니다.
- Markdown 기본 사항
- [ 대한 Markdown
작성하기 위한 추가 리소스
Microsoft Learn에서 테이블의 스타일 지정 방식 때문에 인라인 CSS를 사용해도 테두리 또는 사용자 지정 스타일이 없습니다. 짧은 시간 동안 작동하는 것처럼 보이지만 결국 플랫폼은 테이블에서 스타일을 제거합니다. 따라서 미리 계획하고 테이블을 단순하게 유지합니다. Markdown 테이블을 쉽게 만드는 사이트는 다음과 같습니다. [테이블 생성기]](https://www.tablesgenerator.com/markdown_tables).
Visual Studio Code용 Docs Markdown 확장Visual Studio Code(아래 참조) 사용하여 설명서를 편집하는 경우에도 테이블을 쉽게 생성할 수 있습니다.
리포지토리의 "hololens/images" 폴더에 이미지를 업로드한 다음 문서에서 적절하게 참조해야 합니다. 이미지가 자동으로 전체 크기로 표시되므로 큰 이미지가 아티클의 전체 너비를 채웁니다. 이미지를 업로드하기 전에 이미지의 크기를 미리 조정하는 것이 좋습니다. 권장되는 너비는 600픽셀에서 700픽셀 사이이지만, 각각 조밀한 스크린샷 또는 스크린샷의 일부인 경우 크기를 늘리거나 줄여야 합니다.
중요
병합하기 전에 포크된 리포지토리에만 이미지를 업로드할 수 있습니다. 따라서 아티클에 이미지를 추가하려는 경우 Visual Studio Code 사용하여 먼저 포크의 "images" 폴더에 이미지를 추가하거나 웹 브라우저에서 다음을 수행했는지 확인해야
- MicrosoftDocs/hololens 리포지토리를 포크했습니다.
- 포크에서 문서를 편집했습니다.
- 문서에서 참조하는 이미지를 포크의 "hololens/images" 폴더에 업로드했습니다.
- 포크를 MicrosoftDocs/hololens 기본 분기에 병합하는 끌어오기 요청 만들었습니다.
고유한 포크 리포지토리를 설정하는 방법을 알아보려면 새 문서만드는
웹 브라우저를 통해 GitHub에서 편집하는 동안 페이지 위쪽에 있는 미리 보기 탭을 선택하여 커밋하기 전에 작업을 미리 볼 수 있습니다.
참고
Microsoft Learn에서 변경 내용을 미리 보는 것은 Microsoft 직원만 사용할 수 있습니다.
Microsoft 직원: 기여가 기본 분기에 병합된 경우 기본
브라우저에서 편집하는 것이 빠른 변경을 수행하는 가장 쉬운 방법이기는 하지만 다음과 같은 몇 가지 단점이 있습니다.
- 맞춤법 검사를 받지 않습니다.
- 다른 아티클에 스마트 연결을 가져올 수 없습니다(문서의 파일 이름을 수동으로 입력해야 함).
- 이미지를 업로드하고 참조하는 것은 번거로울 수 있습니다.
이러한 문제를 처리하지 않으려는 경우 기여할 때 몇 가지 유용한 확장Visual Studio Code 같은 데스크톱 클라이언트를 사용합니다.
위에
다음 단계에 따라 이 리포지토리에서 작동하도록 Visual Studio Code를 구성합니다.
- 웹 브라우저에서:
- PC
Git을 설치합니다. - Visual Studio Code
설치합니다. - 아직 포크 MicrosoftDocs/hololens.
- 포크에서 복제를 선택하거나 다운로드하고 URL을 복사합니다.
- PC
- Visual Studio Code에서 포크의 로컬 복제본을 만듭니다.
- 보기 메뉴에서 명령 팔레트선택합니다.
- "Git: Clone"을 입력합니다.
- 복사한 URL을 붙여넣습니다.
- PC에 클론을 저장할 위치를 선택합니다.
- 팝업에서 리포지토리 엽니다.
Visual Studio Code를 사용하여 설명서를 변경하려면 다음 워크플로를 사용합니다.
참고
복제된 포크가 공식 리포지토리와 최신 상태인지 확인합니다.
웹 브라우저에서 기본
MicrosoftDocs/hololens의 기본 분기에 있는 다른 기여자의 최근 변경 내용을 포크에 동기화하는 끌어오기 요청을 만듭니다(화살표가 올바른 대상을 가리키는지 확인). Visual Studio Code에서 동기화 단추를 선택하여 새로 업데이트된 포크를 로컬 클론과 동기화합니다.
Visual Studio Code를 사용하여 복제된 리포지토리에서 문서를 만들거나 편집합니다.
하나 이상의 문서를 편집합니다(필요한 경우 "images" 폴더에 이미지 추가).
탐색기 변경 내용을 저장합니다.
"모두 저장" 선택
소스 제어 모든 변경 내용을 커밋합니다(메시지가 표시되면 커밋 메시지 작성).
"모두 커밋"을 선택합니다.
동기화 단추를 선택하여 변경 내용을 원본(GitHub의 포크)으로 다시 동기화합니다.
웹 브라우저에서 포크의 새 변경 내용을 MicrosoftDocs/hololens 기본 동기화하는 끌어오기 요청을 만듭니다(화살표가 올바른 대상을 가리키는지 확인).
다음 Visual Studio Code 확장은 설명서를 편집할 때 유용합니다.
Visual Studio Code용 Docs Markdown 확장 - Alt+M 사용하여 다음과 같은 Microsoft Learn 제작 옵션 메뉴를 표시합니다.
- 업로드한 이미지를 검색하고 참조합니다.
- 목록, 테이블 및
>[!NOTE]
같은 설명과 같은 서식을 추가합니다. - 내부 링크 및 책갈피(페이지 내의 특정 섹션에 대한 링크)를 검색하고 참조합니다.
- 서식 오류가 강조 표시됩니다(자세한 내용을 보려면 마우스로 오류 위로 마우스를 가져다 놓습니다).
코드 맞춤법 검사기 - 철자가 잘못된 단어에 밑줄이 그어집니다. 철자가 틀린 단어를 마우스 오른쪽 단추로 클릭하여 변경하거나 사전에 저장합니다.