SW공부/git, github

[Github] Markdown 사용

vhxpffltm 2020. 5. 31. 21:53
반응형

Markdown은 텍스트 기반의 마크업언어로 HTML로 변환이 가능하다. 특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다. 깃헙의 저장소Repository에 관한 정보를 기록하는 README.md는 깃헙을 사용하는 사람이라면 누구나 가장 먼저 접하게 되는 마크다운 문서였다. 마크다운을 통해서 설치방법, 소스코드 설명, 이슈 등을 간단하게 기록하고 가독성을 높일 수 있다는 강점이 부각되면서 점점 여러 곳으로 퍼져가게 된다.

 

결과 URL: https://github.com/gjxo12/Reserch_Report/issues/1

 

First: UnderScore, ** [내용] **  , 기울임과 강조

  '** 내용', '_ 내용'  과 같이 각 문자이후 공백으로 띄어야 함  

 

Second: #을 이용한 글자 크기

총 6단계가 있으며 #의 갯수로 지정함, 많을수록 작아지며 # 이후에 띄어야 함

 

Third: Link 

  1) '[텍스트]' 과 (링크주소) 

  ex) [여기를 눌러주세요](www.tistory.com]

  2)  '[][]'으로 사용하는 방법으로 마크 다운 문서의 맨 아래에 괄호로 외부 웹 사이트에 대한 적절한 링크로 정의

  ex) [이곳][another place]입니다.

      [another place]: www.google.co.kr/ 

 

Forth: Image

  이미지는 링크와 마찬가지로 두 가지 스타일이 있으며 링크와 이미지의 차이점은 이미지 앞에 느낌표 !가 있다.

  ) ![텍스트](이미지링크)

 

Fifth: 인용구

  > 기호를 사용하여 인용구호를 만들수 있으며 계층적으로 사용 가능, 기울기 및 글씨체 적용 가능

  ex) >'너 자신을 알라'

 

Sisth: List

  *기호를 사용하여 만들거나 '1.' 과 같이 점을 붙여 사용 가능, 계층구조를 만들려면 들여쓰기로 만들 수 있음, 기울기 및 글씨체 적용 가능

 ex)

  1. _키보드_
  2. **마우스**
  3. **_모니터_**

 

 

etc: 코드, 수평선

  <hr/> 은 수평선을 만들어 준다.

  코드 입력은 <pre><code> 코드내용 </code></pre> 으로 사용한다.

  공백 4개 및 들여쓰기로 블럭을 생성할 수 있으며 한줄을 띄어야 한다

 

 

Reference

https://gist.github.com/ihoneymon/652be052a0727ad59601

https://www.markdowntutorial.com/

 

반응형

'SW공부 > git, github' 카테고리의 다른 글

Git ip 주소 또는 URL 변경시 적용  (0) 2023.04.18
[Gitkraken] fork Repository fetch / 최신화  (0) 2021.11.22
Tortoise git / SVN  (0) 2021.06.28
Git Github 시작하기  (2) 2020.05.21
git 시작하기 (add,commit)  (0) 2019.02.16