GitHub의 리포지토리에 위키라는걸 만들 수 있는데 이게 약간 Pages와 포지션이 약간 겹치는 것 같더라고요. 이번에 라이브러리 하나를 API 참조를 작성해야 하는데 페이지를 써야 할지 위키를 써야 할지 모르겠습니다.
2개의 좋아요
GitHub Pages는 위키 뿐만 아니라 정적 웹 페이지는 무엇이든 다 호스팅할 수 있어서 마치 정적 웹 서버처럼 이용할 수 있는 느낌이 강합니다. 심지어는 웹 사이트가 아니라 파일을 저장하고 공유하기 위한 목적으로도 이용할 수 있습니다. (예: 식탁보 프로젝트 카탈로그)
반면 GitHub Wiki는 GitHub 리포지터리 내에 추가되는 위키 메뉴에 들어갈 콘텐츠만 다루며, 플랫 구조로 만들어진 마크다운 문서 위주로만 보이게 등장합니다. 다른 파일을 넣을 수 있긴 하지만 주 용도가 위키 문서 저장 공간이라 범용적으로는 쓰기 어렵습니다.
만약 프로젝트 문서 정리가 주 목적이지만 문서 사이트를 간단히 만들려 한다면 GitHub Wiki를 쓰시는게 적정하겠습니다.
4개의 좋아요
답변 감사합니다.
2개의 좋아요
그런데 제가 이미 Blazor WebAssembly로 사이트를 하나 만들었는데 Wiki를 쓰면 굳이 관리하는데만 번거로울 것 같아서요…
2개의 좋아요
네. 보통 문서화할 내용이 많지 않다면 그냥 소스와 함께 문서파일을 올려두는게 일반적이지만, 문서의 양이 많아질때 위키 리포지터리를 따로 두곤 합니다.
2개의 좋아요
제가 하고 싶은 말은 “이미 Pages 사이트가 하나 있는데 굳이 위키를 또 쓰는게 맞는건가?” 이런 생각이 들어서 이 질문을 한 것이었습니다. 어쨌든 답변 다시 한번 감사드립니다.
1개의 좋아요
만족하신 답변이 있음에도, 이게 어떤 의미인지 여쭙고 싶네요.
1개의 좋아요
제가 이 라이브러리의 API 참조를 작성하려 했는데 지금 보니까 필요 없을 것 같기도 하고…
3개의 좋아요
참고로 GitHub 위키는 무료 계정에서는 공개 레포에서만 사용할 수 있고, 유료 계정에서는 비공개 레포에서도 사용할 수 있습니다.
개인적으로는 비공개 회사 프로젝트의 개발 가이드로 활용한 사례가 있습니다.
(Pages는 아직 잘 몰라요!)
아… 라이브러리 문서를 만든다는 말씀이셨군요.
API 는 요즘은 웹 API를 지칭하는 게 더 일반적이기 때문에 좀 헷갈렸습니다.