2025.04.29

Git과 Github 심화

Github pages

GitHub에서 제공하는 정적 웹사이트 호스팅 서비스

• 주로 HTML, CSS, JS로 만든 개인 웹페이지, 포트폴리오, 문서 사이트 등을 배포하는 데 사용
  
• 자신의 GitHub 닉네임과 동일한 이름으로 repository 를 생성한다.
• index.html, style.css 등 웹 페이지를 구성하는 파일들을 이 리포지토리에 업로드하고 커밋 & 푸시
  
• Settings > Pages 에 들어간다.
• 배포 브랜치(branch) 와 폴더 (보통 / (root) 또는 /docs)를 선택
  
• 나의 포트폴리오 페이지가 배포 된다.
• https://< username>.github.io/

---

Github Books

swagger 문서의 한계

• Swagger 명세서를 다른 사람들과 공유하려면 배포(Deploy)가 필요
• 커스터마이징이 어렵고, 가독성이 떨어질 수 있다.
• 특히 외부에 보기 좋게 문서를 제공하기 어려운 단점

GitHub Books로 해결할 수 있는 점

• Markdown 기반 편집 가능
• 웹 배포 사이트 제공
• 커스터마이징이 용이하고 직관적임
• 누구나 쉽게 접근하고 문서를 확인

• github 계정이 있다면 연동해서 회원가입을 할 수 있다.
  
• 계정 부분을 누르면 organizaton 을 만들 수 있다.
  
• Published docs site 를 누른다.
  
• 사이트 이름을 작성한다.
  
• 템플릿을 선택한다.
  
• 요금을 선택한다.
  
• 배포 시점을 선택한다.
  
• Edit를 클릭하여 수정 및 Merge
  
• 실제 웹 배포 화면 확인 가능
• Enter your content here 부분에 / 를 하게 되면 다양한 커스터마이징 옵션 등장
  
• API reference 문서 작성
  
• 커스텀을 진행한 후 merge를 누른다.
  
• 왼쪽 상단에 Docs sites 를 누른다.
  
• URL 를 누르면 배포된 화면을 볼 수 있다.
  
• 만약 여러가지 페이지를 만들거나 도메인을 다양하게 만든다면 add new 를 눌러서 group를 만들 수 있다.
  
• 그룹명도 다양하게 설정할 수 있다.