Markdown Preview

Live Markdown preview

Live Markdown preview 브라우저에서 로컬로 실행됩니다.

About the

Markdown 미리보기는 대부분의 사람들이 실제로 사용하는 GitHub 확장 기능(테이블, 작업 목록, 분리된 코드 블록, 취소선 및 자동 링크)을 사용하여 CommonMark를 따라 입력할 때 Markdown을 나란히 보기로 렌더링합니다. 커밋하기 전에 README를 확인하는 가장 빠른 방법입니다. Markdown이 소스에서 보이는 것과 렌더링된 것처럼 보이는 것 사이의 차이가 명확하지 않고, 특히 단일 파이프나 대시가 잘못된 경우 테이블 구문이 자동으로 실패하기 때문입니다. 렌더링된 HTML은 필요한 경우 Markdown 자체를 처리하지 않는 위치에 복사할 수도 있습니다.

Where people use the

README를 확인하면 푸시하기 전에 올바르게 렌더링됩니다.
릴리스 노트 초안 작성 또는 결과의 실시간 보기가 포함된 변경 로그.
Markdown을 허용하지 않는 CMS에 대해 Markdown 문서를 HTML로 변환합니다.
다른 사람의 Markdown 풀 요청을 검토하고 그것이 어떻게 보일지 확인합니다.

How to use the

1
Markdown을(를) 붙여넣거나 작성하세요
편집기는 단일 단락부터 제목, 목록, 링크 및 코드 펜스가 포함된 전체 문서까지 모든 것을 허용합니다.
2
렌더링된 패널 보기
키를 누를 때마다 미리보기가 업데이트되므로 깨진 테이블이나 닫히지 않은 울타리가 게시 단계 이후가 아니라 즉시 표시됩니다.
3
미리보기가 아닌 소스를 수정하세요
미리보기는 읽기 전용입니다. 무언가 잘못 렌더링되는 경우 원인은 거의 항상 구분 기호 행이 없는 목록이나 테이블 헤더 앞에 빈 줄이 없기 때문입니다.
4
필요한 경우 HTML을 복사하세요.
생성된 마크업을 가져오려면 HTML 보기로 전환하세요. 이는 Markdown이 아닌 HTML을 예상하는 CMS에 붙여넣는 데 유용합니다.

팁 및 모범 사례

모든 블록 요소 앞과 뒤에 빈 줄을 남겨두세요. 가장 혼란스러운 렌더링 버그는 빈 줄이 누락된 것입니다.
코드가 일반 텍스트로 처리되지 않고 강조 표시되도록 언어 이름과 함께 분리된 코드 블록을 사용합니다.
긴 문서에서는 한 줄에 한 문장씩 유지하세요. 나중에 diff를 읽을 수 있게 만듭니다.

자주 묻는 질문

어떤 Markdown 사양이 사용됩니까?

CommonMark를 기본으로 사용하고 테이블, 작업 목록, 분리 코드 및 취소선을 위한 GitHub Flavored Markdown 확장 기능을 제공합니다. 이 조합은 GitHub, GitLab 및 대부분의 문서 사이트의 README 형식을 다룹니다.

내 테이블이 렌더링되지 않는 이유는 무엇입니까?

테이블에는 머리글 행과 대시 구분 기호 행이 바로 오고 블록 앞에는 빈 줄이 와야 합니다. 각 행에는 헤더와 동일한 수의 파이프가 있어야 합니다. 누락된 항목 중 하나라도 전체 내용을 파이프 문자가 포함된 텍스트 단락으로 바꿉니다.

내 목록 항목이 한 단락으로 병합된 이유는 무엇입니까?

Markdown에는 단락과 그 뒤에 오는 목록 사이에 빈 줄이 필요합니다. 이것이 없으면 목록 표시자는 일반 텍스트로 처리됩니다.

LaTeX나 수학을 지원하나요?

아니요. 수학 렌더링에는 KaTeX 또는 MathJax와 같은 별도의 라이브러리와 다른 구문이 필요합니다. 여기서 달러 기호 표현식은 일반 텍스트로 렌더링됩니다.

원시 HTML이 허용됩니까?

예, 인라인 HTML은 GitHub가 수행하는 작업처럼 바로 전달됩니다. 출력물을 공개된 곳에 게시하는 경우 먼저 원본 HTML을 사용하여 스크립트를 삽입할 수 있으므로 먼저 정리하세요.

내 문자는 어디로 가나요?

어디에도 없습니다. 구문 분석 및 렌더링은 JavaScript Markdown 라이브러리를 사용하여 브라우저에서 수행됩니다. 아무것도 저장되거나 전송되지 않으므로 복사하지 않는 한 탭을 닫으면 초안이 사라집니다.