| <rowcolor=#000,#fff> 위키 호스팅 서비스 Wiki hosting service |
| FANDOM · GitHub Wiki · Miraheze · Shoutwiki · Personality Database · 위키닷 · 제로스퀘어 |
1. 개요
GitHub 저장소에 내장된 버전 관리 시스템 기반의 위키.2. 기능
2.1. 문서 구조
개별 문서는<문서명.md> 형태로 저장소의 루트 폴더 하위에 작성되며, 폴더를 만들거나 하위 문서를 만드는 것은 원칙적으로 불가능하다. 개별 문서 페이지 주소는 /<문서명>으로 접근할 수 있으며, 확장자는 생략되고 문서명이 URL에 적합하지 않다면 slugify가 이루어진다.일반적으로
Home.md 파일이 FrontPage나 대문과 비슷한 역할을 하며, 주소 입력 시 해당 위키의 루트 경로로 연결된다.2.2. 푸터와 사이드바
푸터(footer)는 일종의 전역 틀 기능으로,_Footer라는 특수한 파일명을 가진 문서를 생성하면 해당 문서의 내용이 모든 문서의 하단에 일괄적으로 삽입된다.GitHub 위키는 별도의 설정이 없을 시 모든 페이지와 하위 문단을 나열하는 기본 사이드바 위젯을 가지고 있으며, Home을 제외하고 알파벳 오름차순으로 정렬된다. 특정한 순서로 문서를 정렬하고 싶다면
_Sidebar.md 문서를 생성해 원하는 내용을 사이드바에 보여줄 수 있다. 사이드바 문서를 생성하게 되면 기본 사이드바 위젯은 접힌 상태로 표시된다.2.3. 문법
GitHub에서 README로 지원 가능한 마크업 언어가 동일하게 지원된다. 특히 마크다운의 경우 GFM (Github Flavoured Markdown)을 기반으로 한다.마크업 언어와 무관하게 미디어위키 문법을 일부 지원한다. 예를 들어 마크다운의 경우, 내부 문서 링크를 걸 때
[]() 대신 [[]]를 사용할 수 있다.2.4. 문서 역사
개별 문서 페이지 또는 위키 주소 하위의
/_history 경로에서 문서/위키 역사를 확인할 수 있다. 개별 문서 역사의 경우 문서의 '.. revisions' 링크를 통해, 위키 전체 역사의 경우 개별 문서 역사의 History / <문서명> 에서 History를 클릭하면 주소를 수동으로 입력하지 않고도 접근할 수 있다.UI는 저장소의 깃 히스토리 화면과 흡사하며, 수정자, 커밋 시각, 커밋 메세지, 커밋 해시 등등을 보여준다.
개별 리비전 경로는
/<커밋 해시> 형태이며, 문서 역사 페이지에서 커밋 해시 링크를 클릭해 해당 과거 리비전을 볼 수 있다.좌측의 체크박스를 클릭해 선택 리비전 비교를 할 수 있는데, 일반적인 diff UI와 비슷하게 개별 파일별 변경사항이 설정에 따라 side-by-side 또는 unified 형태로 보여진다. 경로는
_compare/<커밋 해시1>...<커밋 해시2> 형태로, 브랜치가 하나라는 점만 주의하면 위키 전체 역사를 임의로 비교할 수도 있다.비교 페이지에서 Revert changes 버튼을 눌러 특정 변경사항만을 git revert하는 것이 가능하다. 단, 충돌이 발생할 경우 수동으로 해결할 수는 없고 'This patch was not able to be reversed'라는 메세지와 함께 병합에 실패한다. 이런 경우 로컬로 클론한 뒤 수동으로 병합하는 것이 좋다.
3. 엔진 및 구조
하나의 GitHub Wiki는 내부적으로 하나의 독립적인 Git 저장소 형태로 관리된다. 때문에 일반적인 저장소와 같이 클론하는 것이 가능하다.#!syntax sh
git clone https://github.com/<계정명>/<저장소명>.wiki.git엔진은 GitHub에서 자체적으로 개발한 gollum 엔진을 사용한다. 골룸 엔진 자체는 오픈 소스이기 때문에 GitHub가 아닌 온프레미스 환경에서 호스팅해도 비슷한 기능을 사용할 수 있다.
4. 유명 위키 목록
- gollum - GitHub Wiki의 엔진 gollum 자체의 위키 페이지.
- Visual Studio Code# - 내용이 매우 방대하고 편집자가 많기 때문에 직접 수정이 금지되어 있으며, Microsoft/vscode-wiki저장소를 를 upstream으로 PR을 반영하는 형태이다.
- ArchiSteamFarm - 문서가 총 40개 언어로 번역되어 있는 것이 특징.
- Open Library Project# - 인터넷 아카이브 재단의 공개도서관 프로젝트의 위키로, 해당 프로젝트에서 사용되는 다양한 기호, 컨벤션, 레시피, 디자인 요소 등등이 정리되어 있다.
5. 기타
새 저장소를 만들었을 때, 위키 페이지는 기본적으로 비활성화 되어 있다. 이를 설정 탭에서 활성화할 수 있다.기본적으로 무료 플랜을 사용 중인 개인, 조직 계정에서 생성한 비공개 저장소에서는 사용할 수 없다. 위키 기능을 활성화하려면 공개 저장소이거나 적어도 Pro 플랜 이상이어야 한다.[1]
일반적인 위키위키 사이트와 같이 저장소 소유자나 공동 편집자가 아닌 타인의 편집을 허용할 수도 있다. 기본적으로 비활성화 되어 있으며, 설정에서 'Restrict editing to collaborators only' 옵션을 해제하면 된다. 이렇게 공개된 위키는 GitHub 계정만 있다면 누구나 수정할 수 있다. GitHub 계정에 로그인하지 않고 편집하는 것은 불가능하다.