IT/github

README.md파일과 markdown관련된 것

AsianDude 2023. 9. 2. 11:50

github에 README.md파일이 있는데 그 파일에는 프로젝트에 대한 기본 개요나 설명을 넣을 수 있고, 형식은 markdown형식으로 되어 있다. html과 유사한 방식이나 더 간편하게 되어 있긴 하다. 마크다운 언어 형식과 텍스트를 입력하면 깃허브가 그것을 읽고 html형식으로 문서를 만들어 준다.

 

## ==> 글자를 타이틀 처럼 하게 해준다. html에서는 <h1>, <h2> 등등 태그랑 유사하다. #쓰고 띄어 써야 적용 된다.#를 더 붙일수록 헤딩 글자가 작아진다. #은 엄청 크고, ##은 조금 작고, ###은 더 작고 하다. 

 

--- ==> 구분 선을 만들어 준다.

 

*** ==> 구분 선을 만들어 준다.

 

**글자** ==> 글자를 볼드 체로 바꿔 준다. 앞 뒤로 ** 붙이면 된다.

 

*글자* ==> 글자를 이탤릭체로 바꿔 준다. 앞 뒤로 *붙이면 된다.

 

> ==> blockquote라고 해서 밑에 한 챕터 나눌때 사용할때 유용하다.

 

>> ==> 똑같은 blockquote인데 한 블록쿼트(>)여기서 하나 더 들여 쓰기를 한다.

 

~~글자~~ ==> strike through라고 해서 글자를 밑줄 치게 된다.

 

* ==> 별표를 치고 띄어 쓰기 하면 파워포인트 처럼 점 하고 원하는 글자들을 칠 수 있다.

 

`글자` ==> 앞 뒤에 숫자 1 왼쪽에 있는 따옴표 같은 것을 앞뒤로 묶으면 글자가 블럭처리 되면서 빨강색이 된다.

 

```

글자 ===> 위에 숫자1 왼쪽에 있는 따옴표 같은 것을 3번 치고 엔터 친 다음에 글자 적고 다시 엔터 쳐서 숫자1 옆에 있는  

```              따옴표를 치면 그 글자는 상자에 덮인 블럭 처리가 된다. 

 

[네이버](https://www.naver.com) ==> 네이버가 <a href='www.naver.com'>네이버</a>처럼 링크 텍스트로 변한다.

![글자](이미지URL) ==> 링크 텍스트 형식과 비슷한데 앞에 느낌표가 붙는다.

 

<아래에 보면 마크다운 형식 레퍼런스인데 참고하면 좋다>

https://markdown-it.github.io/