Github의“마크 다운 형식”README 파일이란 무엇입니까?

형식을 만드는 데 체계적 / 명령 줄 요구 사항이 있는지 등 형식이 무엇인지 확실하지 않습니다.

기본적으로 사양을 알아야하고 README 파일을 생성하기위한 기술 단계가 필요합니다.

마크 다운은 시맨틱 정보를 제공하고 일반 텍스트로 일반적인 형식을 나타내는 간단한 구문입니다. Daring Fireball에는 표준 마크 다운을위한 멋진 구문 가이드가 있습니다 . 그런 다음 GitHub는이를 변형하여 GitHub Flavored Markdown이라고 합니다.

readme를 설정하려면 일반 텍스트 파일을 작성하고 파일 이름을 README (또는 README.md / README.markdown)로 지정하고 리포지토리의 루트에 커밋하십시오. 그러면 GitHub가이를 프로젝트 추가 정보로 선택합니다.

Wikipedia — Markdown 은 "GitHub Flavored Markdown-Introduction" 페이지를 참조합니다 ( archv. )

페이지에서 인용 :

GitHub는 메시지, 문제 및 의견에 "GitHub Flavored Markdown"(GFM)을 사용합니다. 몇 가지 중요한 점에서 표준 마크 다운 (SM)과 다르며 일부 추가 기능이 추가되었습니다.

이 페이지는 표준 마크 다운과의 차이점에 대한 설명도 제공합니다.

Markdown이 GitHub에 의해 실제로 렌더링되는 방법에 대한 추가 정보도 있습니다.

Markdown 파일을 렌더링하는 방법에 관심이 있으시면 Sundown 라이브러리에 대한 Ruby 인터페이스 인 Redcarpet 을 확인하십시오 .

분명히 Sundown은 커튼 뒤에서 사용되는 실제 Markdown 파서입니다.

추상화 계층을 하나 더 추가하기 위해 Sundown은 다른 Markdown 파서의 포크입니다 :-) Sundown의 GitHub 페이지
에서 인용 :

Sundown은 Natacha Porté 의 Upskirt 라이브러리 원본 코드를 기반으로하는 Markdown 파서 입니다.

매우 이상하지만 GitHub가 README 파일을 렌더링 할 때 GitHub-Flavoured Markdown (GFM)을 사용하지 않는 것처럼 보입니다 .

GitHub는 사이트 전체에서 "GitHub Flavored Markdown"또는 GFM을 문제, 의견 및 풀 요청으로 사용합니다.

대신 GitHub 마크 업 프로젝트의 일부로 redcarpet이라는 버전을 사용하는 것 같습니다 . 또한 MediaWiki를 포함한 다른 마크 업 형식도 지원합니다. 올바른 파일 확장자를 사용하면 GitHub가 마크 업을 렌더링합니다.

Markdown의 두 가지 맛의 차이점을 보려면 GFM에 대한 설명 과 추가 기능을 읽으십시오 .