gitHub 에서 .md 파일 작성하기 Syntax - GFM ( GitHub Flavored Markdown )

gitHub 에서 .md 파일에서 사용할수 있는 Syntax 정보들입니다. 기본의 Markdown 에서 gitHub 만의 다른점들을 설명하고 있습니다.

원문은 아래의 주소에서 보시면 됩니다.

GitHub Flavored Markdown https://help.github.com/articles/github-flavored-markdown

GFM ( Github Flavored Markdown ) 이 기본 Markdown 과 다른점들

- 번역이 아닌 사용시 알아둬야 할 간단한설명만 드리겠습니다. -

새로운 줄 ( Newlines )

새로운 줄은 간단하게 구분가능합니다.

1번 줄입니다. 후에 자동으로 줄변경이 가능합니다.

2번 줄입니다. 후후...

md 문서에 위와 같이 작성하시면 gitHub 에서 md를 읽을때는 아래와 같이 자동으로 줄이 변경됩니다.

1번 줄입니다. 후에 자동으로 줄변경이 가능합니다.

2번 줄입니다. 후후...

여러 단어 사이의 아래줄 ( Multiple underscores in words )

여러 아래줄 이 있을 경우 단어들을 이텔릭체로 만드는 형식을 무시합니다.

It_s_tutorialboat_all_for_you

hi_do_you_want_more_tutorials

위의 줄은

It_s_tutorialboat_all_for_you

hi_do_you_want_more_tutorials

이텔릭체화 없이 그대로 출력됩니다.

URL 자동링크 ( URL autolinking )

 GFM 에서는 기본적인 URL 정보를 자동으로 연결합니다. 만약 여러분이 URL 이 텍스트가 아니라 URL 로 연결되는 링크를 만들고 싶으시다면 그냥 URL 을 써주시면 자동으로 연결이 됩니다.

최소선 ( Strikethrough )

GFM 에는 취소선이 추가되었습니다.

~~Mistaken text.~~

위의 단어는 아래와 같이 표시될 것 입니다.

Mistaken text.

코드 블럭 ( Fenced code blocks )

GFM 에서 코드를 블럭단위로 설명하고 싶으시다면 아래와 같이 ''' 을 이용하여 코드를 블럭에 따로 써주실수 있습니다.

Hello World 예제 입니다.

'''

function helloworld(){

console.log("Hello World");

}

'''

Syntax highlighting ( Syntax highlighting )

GFM 에서는  코드별 Syntax highlighting 을 지원하고 있습니다.

'''javascript

function helloworld(){

console.log("Hello World");

}

'''

highlighting 정보에 관해서는 링크에서 확인하여 보시기 바랍니다. ( 링크 : the languages YAML file )

할일 리스트 ( Task Lists )

해야 할일 리스트에 관해서 [] 또는 [x] 를 이용하여 표시 할수 있습니다.

-[x] javascript hello world

-[] javascript basic rule

-[] javascript with jQuery

-[] jQuery with jQuery Mobile

이 기능은 현재 사용가능한 기능에 대한 설명 혹은 이슈에 관한 정보를 표시할때 유용 합니다.

일단은 GFM 에서 .md 파일을 작성시 위의 기능만으로도 GFM 에서 사용할 기본적인 문서를 작성하실수 있습니다. 

아래의 글은 추가 내용들로 후에 시간이 나는 대로 작성해보겠습니다.

빠른 인용 - 빠른 댓글 작성 ( Quick quoting )

GFM 에서 r을 누르실경우 빠르게 댓글을 다실수 있습니다.