Markdown은 GitHub 플랫폼에서 모든 형태의 글쓰기를 위한 가볍고 사용하기 쉬운 구문입니다.

여러분이 배울 것은 아래와 같습니다.:

어떻게 Markdown 포멧이 편집을 용이하게 하는지
어떻게 Markdown이 기존의 다른 포멧 접근법과 다른지
어떻게 텍스트를 포멧하기 위해 Markdown를 사용하는지
어떻게 GitHub의 자동 Markdown 번역 기능을 활용하는지
어떻게 GitHub만의 독특한 Markdown 기능을 폭넓게 활용할 수 있는지를 배웁니다.

Markdown 이 뭔가요?

Markdown은 웹상에서 텍스트를 꾸미는 방식입니다. 문서에서 bold체나 italic체로 바꾸고, 사진을 추가하고, 리스트를 정렬하는 것은 그저 Markdown으로 할 수 있는 일부분에 불과하죠. 대체로, Markdown은 # 나 *와 같은 알파벳이 아닌 글자와 함께 이루어져 있습니다. 여러분은 GitHub과 관련된 곳 대부분에서 Markdown을 사용할 수 있습니다.

Gists
Comments in Issues and Pull Requests
.md 이나 .markdown 확장명을 가진 파일들

더욱 더 많은 정보를 원하시면, 여기를 보세요 “Writing on GitHub” GitHub Help.

예시

텍스트

리스트

사진

머릿말과 꼬릿말

코드

기타

Syntax guide

GitHub.com이나 여러분만의 텍스트 파일 어디에서 사용할 수 있는 Markdown 구문이 있습니다.

머릿말

강조

리스트

불규칙

규칙

사진

링크

인용

Inline code

GitHub Flavored Markdown

GitHub.com은 Markdown 구문에서의 특별하고 유용한 특징을 갖고 있는데요. GitHub.com에서 컨텐츠를 만들 때 더 쉽게 만들어줍니다. GitHub만의 Markdown의 몇가지의 특징이 Issues 와 Pull Requests의 설명과 코멘트에서만 오직 사용할 수 있다는 점을 명심하세요. SHA-1 hashes, Issues, 그리고 Pull Requests 뿐만 아니라 @mentions도 포함됩니다. Task Lists는 Gist comments와 Gist Markdown files에서도 이용 가능합니다.

구문 강조

여기 GitHub Flavored Markdown로 구문 강조를 어떻게 사용해야 하는지에 관한 예시가 있습니다.

또한 4번의 공백으로 들여쓰기 할 수도 있습니다.

여기 구문 강조가 없는 Python code의 예시가 있습니다.

Task 목록

첫번째 줄에 Task 목록들을 포함시키면, 손쉽게 진행과정을 확인할 수 있습니다. Pull Requests에서도 적용됩니다.

SHA references

commit’s SHA-1 hash 에 대한 어떤 언급도 GitHub에 있는 그 commit의 링크로 자동 변환될 것입니다.

Issue references within a repository

Issue 나 Pull Request를 언급하는 어떤 번호도 링크로 자동 변환될 것입니다.

Username @mentions

유저이름 뒤에 @ 부호를 사용하면 그 사람이 와서 그 코멘트를 읽으라고 알려주게 됩니다. "@mention"이라고 불립니다. 왜냐하면 여러분이 그 한 개인을 언급하고 있으니까요. 또한 한 기관안에 있는 어떤 팀을 @mention 으로 언급할 수도 있습니다.

URLs를 위한 자동 링크

(http://www.github.com/) 와 같은 어떤 URL이든 클릭할 수 있는 링크로 자동 변환됩니다.

취소선

물결표로 감싸진 단어(~~this~~)는 선이 그어져 보이게 할 수 있습니다.

이모티콘

GitHub은 emoji을 지원합니다.

저희가 지원하는 모든 이모티콘 그림 표를 보고 싶다면, Emoji Cheat Sheet를 클릭하세요.

원문 : https://steemit.com/payout/@timcliff/everything-you-need-to-know-about-potential-payouts-and-flagging-for-new-users

[한글가이드] Markdown 마스터하기 - GitHub Guide