Critical! | Important | Nice To Have |
---|---|---|
Repo Visibility: Public vs Private | ||
Adding Github Collaborators | ||
README files | ||
Writing Markdown | ||
Githun Gists | ||
Github Pages |
공개 저장소는 모든 사람들이 접근 가능하고, 클론이 가능하다.
그러나 저장소의 내용을 변경할 수 있는 것은 아니다.
공동 작업자 권한이나 허가가 있어야 푸쉬가 가능하다.
이것은 만든 소유자, 즉 나만 접근이 가능하다. 혹은 허락된 사람(공동 작업자)만 접근 가능하다.
혹은, 기업용이라면 기업 사람들만 접근 가능하다.
하지만 일반적으론 나와 내가 허락한 사람만 열람 가능하다.
repo의 setting에서 밑으로 스크롤을 하면, Public, Private 설정을 바꿀 수 있다.
공동 작업자와 작업한다는 것은, 변경 사항을 저장소에 푸시하도록 허용하는 것이다.
깃허브의 유저네임이나 이메일을 알면 추가가 가능하다.
이러면 바로 추가되는 것이 아니라 초대장을 클릭해서 초대를 수락해야 한다.
(관리자는 초대를 해야 하고, 다른 사람은 초대를 수락해야 한다.)
공동 작업자 삭제도 Manage Access에서 할 수 있다.
이걸 해 보려면, 다른 계정이 필요하다...
README파일에는 프로젝트가 무엇을 하는지, 무엇을 위한 것인지, 누구를 위한 것인지, 프로젝트를 어떻게 시작하고 실행하는지, 필요한 라이브러리가 있다면 어떻게 설치하는지, 왜 주목할 만 한지, 누가 프로젝트를 관리하는지, 어떻게 공동 작업하고 도움을 받는지 같은 정보가 포함된다.
깃허브( GitHub )는 프로그래머들이 코드를 공유하고 협업하는 데 사용되는 웹 기반 저장소입니다. README 파일은 깃허브 저장소의 가장 중요한 문서 중 하나입니다.
README 파일은 해당 저장소의 설명과 사용 방법을 제공하는 마크다운 파일입니다. 저장소를 방문한 사용자가 처음으로 볼 수 있는 문서입니다. README 파일은 저장소의 개요, 기능, 사용 방법, 기여 방법 및 라이센스와 같은 정보를 제공하는 데 사용됩니다.
README 파일의 내용은 저장소의 유형에 따라 다릅니다. 예를 들어 오픈 소스 프로젝트의 README 파일은 프로젝트의 목적, 기능 및 설치 방법에 대한 정보를 제공합니다. 라이브러리의 README 파일은 라이브러리의 API 문서를 제공하며, 웹 서비스의 README 파일은 API 엔드 포인트 및 데이터 구조를 설명합니다.
README 파일은 깃허브 저장소에 매우 중요합니다. 사용자들은 저장소 방문 시 README 파일을 보고 저장소가 제공하는 내용과 기능을 파악하기 때문입니다. 따라서 README 파일을 자세하게 작성하고 명확하게 구성하는 것이 좋습니다.
프로젝트 루트에 README파일을 넣으면 깃 허브가 자동으로 표시한다.
즉, 깃허브가 내용을 랜더링해서 페이지에 보여준다.
△ 랜더링된 예시
text를 HTML로 바꿔준다.
장점은 구문을 매우 간결하고 쉽게 작성할 수 있고 외울 수 있다는 점이다.
깃허브가 구문을 HTML로 변환한다.
깃허브 기능 지스트는 코드 조각을 간단히 공유하는 방법이다. 페이스트빈이랑 비슷한 도구이다.
GitHub Gists는 코드, 텍스트, 이미지 등을 공유하고 협업할 수 있는 간단한 웹 기반 저장소입니다. 이를 통해 개발자들은 코드 스니펫, 문서, 설명서, 지도, 차트 등을 공유하고 사용할 수 있습니다.
GitHub Gists는 GitHub 계정이 있는 누구나 사용할 수 있습니다. Gist는 단일 파일 또는 여러 파일로 구성된 코드 조각입니다. 사용자는 Gist를 생성하고 공개적으로 또는 개인적으로 공유할 수 있습니다. 또한 Gist는 협업에도 유용합니다. 다른 사용자를 초대하여 함께 작업하거나 댓글을 달 수 있습니다.
GitHub Gists는 코드 스니펫을 공유하는 데 유용합니다. 개발자들은 새로운 기술을 시도할 때 Gist를 사용하여 코드 스니펫을 공유하고 피드백을 받을 수 있습니다. 또한 Gist를 사용하여 코드를 테스트하고 디버깅할 수도 있습니다. Gist는 무료이며, 코드 스니펫을 공유하는 간단하고 효과적인 방법입니다.
마지막으로, GitHub Gists는 API를 통해 접근할 수 있습니다. 이를 통해 개발자들은 자신의 애플리케이션에서 Gist를 사용하고 관리할 수 있습니다.
해당 버튼을 통해 gist를 접근 할 수 있다.
다른 사람들의 코드를 볼 수있다.
Revision을 통해서 개정 이력을 볼 수 있다.
깃허브 밖으로 페이지를 호스팅 할 수 있게 한다.
몇 가지 제한 사항이 존재하는데, 이건 본격적인 호스팅 서비스가 아니므로, 정적 웹 페이지 외에는 아무 것도 할 수 없다.
파이썬, 루비, Node같은 서버 측 언어가 없다. HTML/CSS/JS같은 것만 존재한다.
즉 정적 페이지이다.
하지만 멋진 포트폴리오 웹사이트나 저장소 문서 웹사이트를 만들 수 있다.
자바스크립트 게임을 빌드하는 경우, 깃허브 페이지르 사용하여 호스팅 할 수도 있지만 깃허브 페이지를 접속자가 많을 것 같은 대용량 웹사이트로 사용하고 싶진 않을 것이다.
그런 용도로만 안쓰면 정말 좋은 기능이다.
무료이며, 깃허브에 내장되어 있다.
깃허브 페이지에는 사용자 사이트와 프로젝트 사이트가 존재한다.
ProjectSite
프로젝트 사이트는, 우리가 만든 모든 깃허브 저장소에 대해 호스팅된 웹사이트를 가질 수 있다.
즉, 우리가 만든 모든 저장소, 모든 프로젝트의 웹사이트를 만들 수 있다.
기본 URL은 username,github.io/repo-name 으로 되어있다.
UserSite
깃허브 계정당 하나씩으로 제한된다.
프로젝트 사이트와 다른 응용 프로그램이다.
개인웹사이트, 포트폴리오 뭐든 호스팅 할 수 있다.
기본 URL은 username.github.io이다.
GitHub Project Site와 User Site는 GitHub Pages를 사용하여 웹 사이트를 생성하고 호스팅하는 데 사용됩니다.
GitHub Pages는 정적 웹 사이트를 만들기 위한 무료 호스팅 서비스입니다. GitHub Pages를 사용하면 GitHub 저장소에 저장된 HTML, CSS 및 JavaScript 파일을 호스팅할 수 있습니다. 이를 통해 개발자들은 블로그, 포트폴리오, 문서, API 문서 등을 호스팅할 수 있습니다.
GitHub Project Site는 프로젝트와 관련된 웹 사이트를 만들기 위해 사용됩니다. 예를 들어, 프로젝트의 API 문서, 데모 페이지, 프로젝트 정보 및 기능에 대한 설명을 제공하는 웹 사이트를 만들 수 있습니다. GitHub Project Site는 프로젝트의 소스 코드와 함께 저장소에 포함됩니다.
GitHub User Site는 개인 블로그 또는 포트폴리오 웹 사이트를 만들기 위해 사용됩니다. GitHub User Site는 사용자 이름과 일치하는 저장소의 "username.github.io" 저장소를 사용하여 만들어집니다. 이를 통해 사용자는 자신의 GitHub Pages 웹 사이트를 만들고 호스팅할 수 있습니다.
GitHub Pages를 사용하면 정적 웹 사이트를 쉽게 만들고 호스팅할 수 있습니다. 이 서비스는 무료이며, GitHub 저장소와 함께 사용할 수 있어 개발자들에게 매우 유용합니다.