Skip to main content

위키 정보

리포지토리에 대한 설명서를 wiki에 호스트하여 다른 사용자가 사용하고 프로젝트에 참여할 수 있습니다.

누가 이 기능을 사용할 수 있나요?

Wiki는 조직의 GitHub Free 및 GitHub Free이(가) 있는 퍼블릭 리포지토리와 GitHub Pro, GitHub Team, GitHub Enterprise Cloud 및 GitHub Enterprise Server의 퍼블릭 리포지토리 및 프라이빗 리포지토리에서 사용할 수 있습니다. 자세한 내용은 “GitHub의 플랜”를 참조하세요.

GitHub의 모든 리포지토리에는 호스팅 문서 섹션이 제공되는데, 이를 Wiki라고 합니다. 리포지토리의 wiki를 사용하여 프로젝트 사용 방법, 프로젝트를 설계한 방법 또는 핵심 원칙 등 프로젝트에 대한 긴 형식의 콘텐츠를 공유할 수 있습니다. 추가 정보 파일을 참조하면 프로젝트의 용도를 빠르게 파악할 수 있는 반면에 wiki를 사용하면 추가 문서를 제공할 수 있습니다. 자세한 내용은 "추가 정보"을(를) 참조하세요.

Wiki를 사용하면 GitHub의 다른 곳과 마찬가지로 콘텐츠를 작성할 수 있습니다. 자세한 내용은 "GitHub에서 작성 및 포맷 시작"을(를) 참조하세요. 오픈 소스 Markup 라이브러리를 사용하여 다양한 형식을 HTML로 변환하므로 Markdown 또는 지원되는 다른 형식으로 작성하도록 선택할 수 있습니다.

Markdown을 사용하여 렌더링된 수학 식, 다이어그램, 맵 및 3D 모델을 wiki에 추가할 수 있습니다. 렌더링된 수학 식을 만드는 방법에 대한 자세한 내용은 "수학 식 작성"을(를) 참조하세요. 다이어그램, 지도, 3D 모델을 만드는 방법에 대한 자세한 내용은 "다이어그램 만들기"을(를) 참조하세요.

퍼블릭 리포지토리에서 wiki를 작성하는 경우 wiki는 일반 대중이 사용할 수 있습니다. 프라이빗 리포지토리에서 wiki를 작성한 경우 해당 리포지토리에 대한 액세스 권한이 있는 사람만 wiki에 액세스할 수 있습니다. 자세한 내용은 "리포지토리 표시 유형 설정"을(를) 참조하세요.

GitHub에서 직접 wiki를 편집하거나 wiki 파일을 로컬로 편집할 수 있습니다. GitHub.com의 모든 사용자가 퍼블릭 리포지토리의 wiki에 기여하도록 허용할 수 있긴 하지만 기본적으로 리포지토리에 대한 쓰기 액세스 권한이 있는 사용자만 wiki를 변경할 수 있습니다. 자세한 내용은 "Wiki에 대한 액세스 권한 변경"을(를) 참조하세요.

참고: 검색 엔진은 공개 편집을 방지하기 위해 구성한 별 500개 이상의 위키만 인덱싱합니다. 자세한 내용은 "Wiki에 대한 액세스 권한 변경"을(를) 참조하세요.

검색 엔진에서 콘텐츠를 인덱싱하려면 퍼블릭 리포지토리에서 GitHub Pages를 사용할 수 있습니다. 자세한 내용은 "GitHub Pages"을(를) 참조하세요.

참고: 성능상의 이유로 Wiki에는 파일 형식에 관계없이 총 5,000개의 파일이라는 소프트 한도가 있습니다. 이 한도를 초과하면 일부 페이지에 사용자가 액세스할 수 없을 수 있습니다. 더 큰 Wiki가 필요한 경우 GitHub Pages을(를) 사용하는 것이 좋습니다. 자세한 내용은 "GitHub Pages"을(를) 참조하세요.

추가 참고 자료