Git Readme.md 작성법 / 마크다운 문법

seeseal·2022년 1월 24일
0

Git

목록 보기
2/2
post-thumbnail

Git 첫 readme.md를 작성하며 마크다운 문법에 대해서 알아봤다.
더 많은 내용이 있겠지만 git readme.md를 작성하며 반드시 알아야 했던 문법을 기록하려고 한다.

Markdown 이란?

마크다운(markdown)은 일반 텍스트 문서의 양식을 편집하는 문법이다. README 파일이나 온라인 문서, 혹은 일반 텍스트 편집기로 문서 양식을 편집할 때 쓰인다. 마크다운을 이용해 작성된 문서는 쉽게 HTML 등 다른 문서형태로 변환이 가능하다.
(출처 : 위키백과)

📖 내용 작성

1. 제목

제목은 #의 개수를 이용하여 작성한다.
✍ 마크다운 작성 시

# h1
## h2
### h3
#### h4

👉 결과

h1

h2

h3

h4

2. 줄 바꿈

줄바꿈은 <br/> 로 작성된다.
혹은 띄어쓰기 두 번 후 엔터를 쳐도 된다.
이 글 작성하면서 알았는데 코드 블럭이란 게 있다.
상단 가장 오른쪽의 <>를 누르고 코드를 작성하면 <br/>도 줄바꿈으로 인식되지 않고 그냥 글자로 인식한다. 벨로그도 마크다운 언어였어... 쉬운 게 없구나!😭

3. 순서

✍ 마크다운 작성 시

1. 첫 번째
2. 두 번째
3. 세 번째

👉 결과
1. 첫 번째
2. 두 번째
3. 세 번째

4. 이미지 링크


git 상단의 issue에 들어가서 사용할 이미지를 끌어주면 링크가 생긴다.
그 링크를 readme.md에 붙여 넣으면 된다.

5. 테이블 만들기

테이블은 | 로 구분한다. shift + \ 를 누르면 나오는 문자이다.
한글 ㅣ인 줄 알고 이렇게 작성했다가 안돼서 당황했었다.🤣
또한 -으로 구분된 곳 왼쪽, 양쪽, 오른쪽에 :을 붙일 경우 순서대로 왼쪽 정렬, 가운데 정렬, 오른쪽 정렬이 가능하다.

😁 마무리하며

일단 기본적인 readme.md를 작성하는 데는 이 정도를 사용하였다.
단순해 보이지만 처음 사용해서 생각보다 찾아보는 데 오래 걸렸다.
그래도 새로운 것을 많이 알게 돼서 뿌듯했고 velog 작성하면서 더 많은 것을 알게 될 것 같다.
그리고 이게 나의 velog 첫 글인데 너무 신기하고 유용해 보여서 재밌다.
앞으로 1일 1 velog 해야지!😝

0개의 댓글