Skip to main content

GitHub README 마크다운 문법 정리


GitHub README 마크다운 문법 정리

  • .md 확장자는 마크다운 문서
  • GitHub는 README.md를 자동으로 프로젝트 홈에서 보여준다.
  • 코드 블럭에 언어명을 지정하면 문법 강조가 적용된다. (예: javascript, python, bash)


📝 1. 제목 (Headings)
# H1 제목
## H2 제목
### H3 제목
#### H4 제목
##### H5 제목
###### H6 제목


✍️ 2. 강조 (Emphasis)
*기울임*  또는  _기울임_  
**굵게**  또는  __굵게__  
***굵고 기울임***  또는  ___굵고 기울임___


📋 3. 목록 (List)

● 순서 없는 목록

- 항목 1
- 항목 2
  - 하위 항목

● 순서 있는 목록

1. 첫 번째 항목
2. 두 번째 항목
   1. 하위 항목


💻 4. 코드 (Code)

● 인라인 코드

`코드`
예: `console.log("Hello")`

● 코드 블럭

<pre> <code> ```javascript function hello() { console.log("Hello, world!"); } ``` </code> </pre>


🔗 5. 링크 & 이미지
  • 링크
[링크텍스트](https://example.com)
  • 이미지
![설명](이미지URL)
  • 예
![로고](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)


💬 6. 인용문 (Blockquote)
> 인용문입니다.
>> 중첩 인용문도 가능합니다.


📏 7. 수평선 (구분선)
---
***
___


✅ 8. 체크박스 (To-do List)
- [ ] 할 일
- [x] 완료된 일


📂 9. 접기 기능 (Details Toggle)
<details>
<summary>여기를 클릭해서 열기</summary>

숨겨진 내용을 여기에 작성합니다.

</details>




Back to top