GitHub Readme 마크다운 사용법 (체크리스트, 이모티콘, 코드블럭, 폰트, 링크)
GitHub에서의 마크다운 작성법을 익히면 문서를 보다 간편하게 편집할 수 있습니다. 체크리스트, 이모티콘, 코드 블록, 폰트 스타일, 링크, 이미지 등 다양한 기능을 활용하여 가독성 높은 문서를 만들어보세요. 이 글에서는 GitHub 마크다운의 기본 사용법과 예시 코드를 알려드리겠습니다.
GitHub 마크다운 사용법
1. 체크리스트 사용하기
GitHub 마크다운에서는 편리한 체크리스트를 만들 수 있습니다. 아래는 예시입니다.
- [ ] task1
- [x] task2
위 마크다운 코드를 사용하면 체크박스를 통해 간단한 작업 목록을 만들 수 있습니다.
2. 이모티콘 활용하기
GitHub 마크다운에서는 이모티콘을 사용하여 문서에 감정이나 상태를 표현할 수 있습니다. 예를 들면,
:smile: - 웃음
:thumbsup: - 좋아요
:warning: - 경고
위와 같이 코드를 작성하면 해당 이모티콘이 표시됩니다.
※ 더 자세한 이모티콘 용어가 궁금하다면 참고하세요
3. 코드 블록 작성하기
GitHub 마크다운에서 코드 블록을 작성하는 방법은 다음과 같습니다.
```
여기에 코드를 작성하세요
```
여기서 특정 프로그래밍 언어로 설정하고 싶다면 아래처럼 첫번째 ```(backticks) 뒤에 언어를 설정하면 됩니다.
```javascript
console.log("Hello, GitHub Markdown!");
```
4. 폰트 스타일 적용하기
굵게, 기울임, 밑줄 등의 폰트 스타일을 적용하려면 다음과 같이 작성합니다.
**굵은 글씨**
*기울임*
~~취소선~~
5. 링크 추가하기
하이퍼링크를 추가하려면 다음과 같이 작성합니다.
[GitHub](https://github.com)
위 코드는 "GitHub"이라는 텍스트에 GitHub 링크를 추가합니다.
6. 이미지 삽입하기
이미지를 삽입하려면 다음과 같이 작성합니다.
![레몬사진](https://newswave25.com/wp-content/uploads/2021/12/Screenshot-2021-12-08-113111.png)
위 코드는 이미지 설명과 링크된 이미지를 추가합니다.
끝으로
GitHub 마크다운은 다양한 기능을 제공하여 문서 작성을 효과적으로 할 수 있습니다. 이러한 기능들을 활용하여 깔끔하고 가독성 있는 문서를 작성해보세요.
▼ 아래 글도 읽어보세요! ▼
'Programming & Platform > Git & Github' 카테고리의 다른 글
GitHub 브랜치, 로컬과 원격에서 삭제하는 방법 (1) | 2023.11.28 |
---|---|
GitHub Commit 메시지로 이슈 종료하는 방법 (0) | 2023.11.27 |
Git, 실수로 삭제한 파일 복구하는 방법 (0) | 2023.11.17 |
gitignore 사용법 - 소스코드 제공 사이트 소개 (gitignore.io) (1) | 2023.11.03 |
터미널에서 SSH키 발급 받는 법, 안전한 원격 접속을 위한 필수 단계 (0) | 2023.11.02 |