GitHub에서는 README.md 파일을 활용하여 프로젝트를 소개합니다. .md 파일은 Markdown 문법을 사용하므로 이를 숙지하는 것이 중요합니다.
| Element | Markdown Syntax |
|---|---|
| Heading | # H1 ## H2 ### H3 |
| Bold | **bold text** |
| Italic | *italicized text* |
| Blockquote | > blockquote |
| Ordered List | 1. First item 2. Second item 3. Third item |
| Unordered List | - First item - Second item - Third item |
| Code | `code` |
| Horizontal Rule | --- |
| Link | [title](https://www.example.com) |
| Image |  |
| Element | Markdown Syntax |
|---|---|
| Table | | Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text | |
| Fenced Code Block | ``` { "firstName": "John", "lastName": "Smith", "age": 25 } ``` |
| Footnote | Here's a sentence with a footnote. [^1] [^1]: This is the footnote. |
| Heading ID | ### My Great Heading {#custom-id} |
| Definition List | term : definition |
| Strikethrough | ~~The world is flat.~~ |
| Task List | - [x] Write the press release - [ ] Update the website - [ ] Contact the media |
| Emoji | That is so funny! :joy: |
| Highlight | I need to highlight these ==very important words==. |
| Subscript | H~2~O |
| Superscript | X^2^ |
Markdown은 GitHub의 README.md 작성, Pull Request 설명, 블로그(예: Velog) 작성 등에 자주 사용됩니다.
하지만 문법이 어렵지 않으므로, 처음에는 정리를 참고하며 적용하고 익숙해지면 자연스럽게 사용할 수 있습니다. 🚀
레포지토리명: (내 아이디).github.io로 지을 것!
clone후 html 생성 -> push
https://(내 아이디).github.io 에서 확인하면 됨.