GitHub 저장소와 문서 잇기

문서 하나를 GitHub 저장소의 .md 파일 하나와 이어 둘 수 있습니다. 이은 뒤에는 GitHub 쪽 변경을 당겨 합치고, 이 앱에서 고친 내용을 커밋으로 푸시합니다. 저절로 맞춰지지 않고 당기기와 푸시를 누를 때만 오갑니다. 로그인한 계정에서만 쓸 수 있고, 운영 쪽에서 기능을 꺼 두면 메뉴가 보이지 않거나 지금은 GitHub 기능을 쓸 수 없습니다가 뜹니다.

계정 연결과 권한

사이드바 설정의 계정 탭 GitHub 묶음에서 GitHub 연결을 누릅니다. GitHub 화면에서 허락하면 앱으로 돌아오고 GitHub에 연결했습니다가 뜹니다
아직 이 앱의 GitHub 앱을 설치한 저장소가 없으면 설치 화면으로 갑니다. 이 앱은 GitHub 앱을 설치한 저장소만 봅니다

고르기 창의 저장소 추가…는 새 탭에 설치 화면을 엽니다. 저장소를 더하고 돌아오면 목록이 새로 뜹니다
쓰기 권한이 없는 저장소는 — 쓰기 권한 없음이 붙고 고를 수 없습니다
GitHub 계정 하나는 이 앱 계정 하나에만 이을 수 있습니다. 다른 계정에 이미 이어져 있으면 이 GitHub 계정은 이미 다른 계정에 연결돼 있습니다가 뜹니다
GitHub 열쇠(토큰)는 서버에 AES-256-GCM(표준 암호화 방식)으로 암호화해 둡니다. 연결이 만료되면 GitHub 연결이 만료됐습니다. 다시 연결해 주세요가 뜨고, GitHub 연결을 다시 누르면 됩니다
같은 묶음의 연결 해제는 이 앱에 준 GitHub 권한을 거두고 연결을 지웁니다. 문서 하나의 연결만 끊으려면 아래 연결 해제…를 씁니다
연결과 해제는 온라인일 때만 할 수 있습니다

저장소 파일 가져오기

사이드바 가져오기를 누르고 GitHub에서 가져오기를 고릅니다(명령 팔레트 GitHub에서 가져오기…도 같습니다).

저장소와 브랜치를 고릅니다. 브랜치는 기본 브랜치로 시작합니다
폴더를 눌러 들어가고 상위 폴더로 나옵니다. 목록에는 폴더와 .md·.markdown 파일만 보입니다
파일을 고르고 가져오기를 누르면 그 파일과 이어진 새 문서가 열립니다. 제목은 확장자를 뗀 파일 이름입니다

이미 어떤 문서와 이어진 파일이면 새로 만들지 않고 이미 이 GitHub 파일에 연결된 문서를 열었습니다가 뜹니다
1MB를 넘는 파일과 UTF-8이 아닌 파일은 가져오지 않습니다
목록은 저장소 300개, 브랜치 100개, 한 폴더 1,000항목까지 보입니다

새 파일로 시작하기

가져오기 → GitHub에 새 파일은 빈 문서를 만들어 저장소에 새 파일로 올립니다. 저장소·브랜치·폴더를 고르고 파일 이름과 커밋 메시지를 적은 뒤 연결하고 푸시를 누르면 이어진 새 문서가 열리고 첫 커밋까지 끝납니다.

파일 이름은 .md나 .markdown으로 끝나야 하고 /를 넣을 수 없습니다
커밋 메시지는 새 문서.md 추가처럼 채워져 있습니다
그 폴더에 같은 이름의 파일이 있으면 만들지 않습니다. 그 파일은 GitHub에서 가져오기로 엽니다

쓰던 문서 잇기

문서 ⋯ 메뉴의 GitHub에 연결…이나, 지금 문서의 상단바 GitHub 버튼 → GitHub에 연결…로 엽니다. 파일 이름에는 문서 제목에서 만든 이름이 들어 있습니다.

저장소에 있는 파일을 고르면 연결만 하고, 곧 그 문서로 가서 당기기가 시작됩니다
없는 경로를 적었고 그 문서가 지금 열려 있으면 연결하고 푸시로 바로 첫 커밋을 합니다. 그 밖에는 연결만 하고 첫 푸시가 파일을 만듭니다
이어진 문서의 ⋯ 메뉴는 GitHub 연결 정보…로 바뀌어 저장소·브랜치·경로와 마지막 동기화 시각, GitHub에서 보기, 연결 해제…를 보여 줍니다

상단바 `GitHub` 메뉴

이어진 문서를 열면 메뉴 맨 위에 저장소와 경로, 마지막 동기화 시각이 보이고 아래에 당기기…·푸시…·GitHub에서 보기·연결 해제…가 있습니다. 명령 팔레트의 이 문서 GitHub에서 당기기…·이 문서 GitHub에 푸시…도 같습니다.

연결 해제…는 문서와 파일의 연결만 끊습니다. 본문과 GitHub 파일은 그대로입니다
당기기와 푸시는 문서가 온라인으로 열려 있을 때만 됩니다

당기기와 합치기

당기기…는 GitHub 파일을 받아 지금 내용과 견줍니다. 같으면 GitHub 파일과 같습니다만 뜨고 끝납니다. 다르면 GitHub에서 당기기 창이 열립니다.

빨간 줄은 GitHub, 초록 줄은 지금 내용입니다. 바뀐 덩어리마다 내 것 유지나 GitHub 것으로를 누르고, 모두 내 것·모두 GitHub 것으로 한꺼번에 고릅니다
창 안 본문을 직접 고칠 수도 있습니다. 고르지 않은 덩어리는 지금 내용으로 남습니다
적용을 누르면 결과가 문서에 들어가고 GitHub에서 당겨 합쳤습니다가 뜹니다.
줄바꿈 형식(LF·CRLF)이 다르면 창에 알려 줍니다. 푸시하면 이 문서의 형식으로 올라갑니다
합친 결과가 1MB를 넘으면 적용하지 않습니다

푸시

푸시…는 GitHub에 푸시 창을 엽니다. 위에 저장소·브랜치·경로가 보이고, 커밋 메시지(1,000자까지)를 적어 푸시를 누릅니다. 끝나면 푸시했습니다와 함께 GitHub에서 보기가 뜹니다.

그사이 GitHub 파일이 바뀌었으면 푸시하지 않고 GitHub 파일이 바뀌었습니다. 당겨서 합친 뒤 푸시하세요가 뜹니다. 같은 창의 당기기…로 합친 뒤 다시 푸시합니다
문서에 넣은 이미지는 .md 파일 옆 attachments/ 폴더에 함께 올라갑니다. 한 번에 50장까지이고, 남은 그림은 다음 푸시에 올라갑니다. 금고 그림과 아직 서버에 올라가지 않은 그림은 올리지 않습니다
바뀐 것이 없으면 커밋을 만들지 않고 GitHub 파일과 같습니다가 뜹니다
빈 저장소, 보호 규칙 때문에 쓸 수 없는 브랜치에는 푸시할 수 없습니다

GitHub에서 문법이 어떻게 보이는지는 한 번 쓴 글을 다른 도구로 옮기기를 보세요.

저장소 그림

보통 문서에서 ./img/a.png 같은 경로의 그림은 글자로 남지만(문서에 이미지 넣기), GitHub와 이어진 문서에서는 .md 파일 기준 상대 경로의 저장소 그림이 편집·보기 화면과 공개 링크에서 보입니다. 본문 글자는 바꾸지 않습니다.

문서 주인이 가져오거나 당기면, 5MB 이하 그림을 한 번에 50장까지 받아 이 문서의 이미지로 저장합니다. 이미지 용량에 들고, 못 받은 그림은 다음 당기기 때 다시 받습니다
SVG와 아직 받지 않은 그림은 주인의 GitHub 연결로 저장소에서 바로 불러옵니다. 주인의 연결이 만료되면 보이지 않습니다
연결을 끊으면 저장소 그림이 그 문서에 더는 보이지 않습니다

되는 사람과 한도

연결·당기기·푸시·연결 해제는 문서 주인만 합니다. 편집 권한으로 초대받은 사람은 이어진 문서에서 GitHub 메뉴의 GitHub에서 보기만 쓰고, 보기 권한에는 메뉴가 없습니다
금고 문서는 GitHub에 이을 수 없고, 이어진 문서는 연결을 끊어야 금고로 옮길 수 있습니다
운영 쪽에서 한 달 사용 횟수를 정해 둘 수 있습니다. GitHub 묶음에 이번 달 3회 사용이나 이번 달 3/20회 사용처럼 보입니다. 파일 가져오기와 당기기가 한 번씩 세고, 다 쓰면 다음 달 1일까지 가져오기·당기기·푸시가 막힙니다
GitHub 쪽 요청 한도에 걸리면 GitHub 요청이 많아 잠시 뒤에 다시 해 주세요가 뜹니다