README 에디터 (마크다운 편집기)

GitHub와 같은 모양의 실시간 미리 보기를 보며 README.md 파일을 쓰는 무료 README 편집기입니다. 클릭할 수 있는 목차, 작업 목록, 표, 코드 블록을 지원합니다. 예제 README에서 시작해 도구 모음이나 단축키로 서식을 넣고, .md 파일이나 따로 열리는 HTML 페이지로 내려받으세요. 초안은 입력하는 동안 브라우저에 저장됩니다.

사용법

1. 편집기에 마크다운을 작성하거나 .md 파일을 끌어다 놓기, 열기, 붙여 넣기로 불러오세요. 처음에는 예시 README가 들어 있습니다.
2. 툴바나 단축키로 굵게, 기울임, 제목, 링크, 목록, 체크리스트, 코드, 인용, 표를 넣을 수 있습니다.
3. 미리보기로 바꾸면 클릭할 수 있는 목차와 함께 GitHub 스타일 결과를 보고, HTML로 바꾸면 생성된 코드를 볼 수 있습니다.
4. HTML을 복사하거나, 스타일이 적용된 단독 .html 페이지 또는 .md 파일로 내려받으세요.

• GitHub Flavored Markdown을 지원합니다. 표, 체크리스트, 펜스 코드 블록, 취소선, 자동 링크를 쓸 수 있고, 제목에는 GitHub 방식의 앵커 id가 붙습니다.
• HTML은 안전하게 정리되므로 스크립트와 위험한 속성은 결과에서 제거됩니다.
• 작성 중인 글은 이 브라우저에 자동으로 저장되어 다시 열어도 그대로 남아 있습니다.
• 넓은 화면에서는 나란히 보기로 편집기와 미리보기를 함께 볼 수 있습니다.

좋은 README에 들어갈 내용

README는 저장소에서 가장 먼저 읽히는 문서라서 ‘무엇을 하는 프로젝트인가’, ‘어떻게 설치하나’, ‘어떻게 쓰나’ 세 가지에 바로 답해야 합니다. 흔히 한 줄 설명, 짧은 예시나 스크린숏, 설치 방법, 코드 블록이 있는 사용법, 설정, 기여 방법, 라이선스 순서로 씁니다. 첫 문단에는 전문 용어를 줄이고 자세한 내용은 뒤로 미루세요.

언어 이름을 붙인 코드 블록(```js, ```bash)은 GitHub에서 문법 강조가 됩니다. docs/setup.md 같은 상대 링크는 저장소 안에서 동작하고, 이미지도 저장소의 파일을 가리킬 수 있습니다.

GitHub Flavored Markdown

미리 보기는 CommonMark 표준을 확장한 GitHub Flavored Markdown(GFM)을 따릅니다. 제목, 목록, 링크, 강조 외에 세로 막대로 쓰는 표, - [ ]와 - [x] 작업 목록, ~~취소선~~, URL 자동 링크, 울타리 코드 블록을 쓸 수 있습니다. 모든 제목에는 GitHub 방식의 앵커 ID가 붙어 #설치 같은 링크로 해당 절로 이동할 수 있고, 목차가 이 방식을 씁니다. 한글 제목도 앵커가 됩니다.

자주 묻는 질문