Github 정리를 해보기로 마음먹으면서 제일 먼저 마주하게 된 것이 README.md이고
이 README.md가 바로 가장 흔히 접할 수 있는 마크다운으로 작성된 파일이다.
앞으로의 마크다운 사용을 위해 마크다운에 대해 정리해보려고 한다.
1. 마크다운 (Markdown)
: 일반 텍스트 기반의 경량 마크업 언어
(마크업 언어 : 태그 등을 이용해 문서나 데이터의 구조를 명기하는 언어의 한 가지로 HTML, XML이 그중 하나이다.)
: 일반 텍스트로 서식이 있는 문서를 작성하는 데 사용되며, 일반 마크업 언어에 비해 문법이 쉽고 간단한 것이 특징이다.
: 응용 소프트웨어와 함께 배포되는 README 파일이나 온라인 게시물 등에 많이 사용된다.
1-1. 마크다운의 장점
- 문법이 쉽고 간결하다
- 관리가 쉽다
- 별도의 도구 없이 작성이 가능하다.
- 다양한 형태로 변환이 가능하다.
- 지원 가능한 플랫폼과 프로그램이 다양하다.
- 텍스트로 저장되기 때문에 용량이 적어 보관이 용이하다.
1-2. 마크다운의 단점
- 표준이 없기 때문에 표현하는 도구에 따라서 동작하지 않거나, 다르게 표현될 수 있다.
- 모든 HTML 마크업을 대신하지 못한다.
2. 마크다운 문법
2-1. 헤더
- # 뒤에 띄어쓰기를 넣어 작성
- <h1>~<h6>까지 표현이 가능하다. (# ~ ######)
- h1, h2는 각각 ===, ---로도 대체가 가능하다.
# h1제목
## h2제목
### h3제목
#### h4제목
##### h5제목
###### h6제목
h1제목
===
h2제목
---
2-2. 강조
*이탤릭체*, _이탤릭체_
**볼드체**, __볼드체__
~~취소선~~
2-3. 수평선
- * 또는 _ 또는 - 를 3개 이상 작성
* * *
***
*****
---
- - -
-------------------
___
2-4. 하이퍼링크
[링크명](https://dain-ing.tistory.com/)
[링크명](https://dain-ing.tistory.com/ "hover시 나타나는 title")
링크명 https://dain-ing.tistory.com/
링크명 <https://dain-ing.tistory.com/>
2-5. 인용
- > 으로 시작하는 텍스트
- >는 3개까지 가능
> 인용
>> 중첩 인용
>>> 중접 인용2
2-6. 리스트
2-6-1. 순서가 있는 리스트
- 숫자를 기입하면 순서가 있는 리스트가 된다.
- 기입한 숫자는 큰 의미가 없으며 순서대로 알아서 숫자가 매겨진다.
- 들여 쓰기를 하면 들여쓰기 안에서부터 1부터 다시 매겨진다.
1. 리스트 1
1. 리스트 1-1
2. 리스트 2
4. 리스트 3
2-6-2. 순서가 없는 리스트
- *, +, - 를 기입하면 순서가 없는 리스트가 된다.
- 들여쓰기를 하면 모양이 바뀐다.
* 리스트 1
- 리스트 2
+ 리스트 3
- 리스트 3-1
* 리스트 3-2
2-7. 특수문자
- 마크업 문법으로 사용되는 특수문자의 경우 앞에 \를 붙여 작성해주면 표현이 가능하다.
\* 특수문자 출력
2-8. 이미지
- 링크와 유사하지만 앞에 !가 붙는다.
- , 


- 이미지에 링크 추가 : [](링크)
[](https://ko.wikipedia.org/wiki/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4)
2-9. 테이블
- | (Vertical Bar) 기호를 통해 테이블을 표현할 수 있다. (가장 좌측과 우측은 생략 가능하다)
- 헤더와 셀 구분은 3개 이상의 - (하이픈, 대시)를 작성해야 한다.
헤더1 | 헤더2 | 헤더3
--- | --- | ---
셀1 | 셀2 | 셀3
- 헤더와 셀 구분 시 :(콜론) 기호로 정렬을 할 수 있다.
헤더1 | 헤더2 | 헤더3
:---|:---:|---:
좌측정렬 | 중앙 | 우측정렬
2-10. 코드 블록
- ``` 혹은 ~~~ 로 감싸 작성
- ```, ~~~ 뒤에 언어를 지정해주면 syntax color가 적용된다.
```html
<h1>hi</h1>
```
~~~javascript
function add(){
console.log("add");
}
~~~
'TIL' 카테고리의 다른 글
[TIL] 세션, 쿠키, 웹스토리지 (0) | 2023.02.26 |
---|---|
[TIL] 브라우저의 동작 방식 및 렌더링 원리 (0) | 2023.02.25 |
[TIL] 프로세스와 스레드 (0) | 2023.02.25 |
[TIL] Rest, Rest API, Restful (0) | 2023.02.25 |
[TIL] CSR과 SSR (0) | 2023.02.25 |