본문 바로가기
Programming & Platform/Git & Github

GitHub Readme 마크다운 사용법 (체크리스트, 이모티콘, 코드블럭, 폰트, 링크)

by 코드스니펫 2023. 11. 21.
반응형

GitHub Readme 마크다운 사용법 (체크리스트, 이모티콘, 코드블럭, 폰트, 링크)

 

github logo

 

GitHub에서의 마크다운 작성법을 익히면 문서를 보다 간편하게 편집할 수 있습니다. 체크리스트, 이모티콘, 코드 블록, 폰트 스타일, 링크, 이미지 등 다양한 기능을 활용하여 가독성 높은 문서를 만들어보세요. 이 글에서는 GitHub 마크다운의 기본 사용법과 예시 코드를 알려드리겠습니다.

 

 

GitHub 마크다운 사용법

 

 

1. 체크리스트 사용하기

GitHub 마크다운에서는 편리한 체크리스트를 만들 수 있습니다. 아래는 예시입니다.

- [ ] task1
- [x] task2

 

 

마크다운 체크리스트

 

위 마크다운 코드를 사용하면 체크박스를 통해 간단한 작업 목록을 만들 수 있습니다.

 

 

2. 이모티콘 활용하기

GitHub 마크다운에서는 이모티콘을 사용하여 문서에 감정이나 상태를 표현할 수 있습니다. 예를 들면,

:smile: - 웃음
:thumbsup: - 좋아요
:warning: - 경고

 

마크다운 이모티콘

 

위와 같이 코드를 작성하면 해당 이모티콘이 표시됩니다. 

 

 

Complete list of github markdown emoji markup

Complete list of github markdown emoji markup. GitHub Gist: instantly share code, notes, and snippets.

gist.github.com

※ 더 자세한 이모티콘 용어가 궁금하다면 참고하세요

 

 

3. 코드 블록 작성하기

GitHub 마크다운에서 코드 블록을 작성하는 방법은 다음과 같습니다.

```
여기에 코드를 작성하세요
```

 

마크다운 코드블럭

 

여기서 특정 프로그래밍 언어로 설정하고 싶다면 아래처럼 첫번째 ```(backticks) 뒤에 언어를 설정하면 됩니다.

```javascript
console.log("Hello, GitHub Markdown!");
```

 

마크다운 코드블럭 언어

 

 

4. 폰트 스타일 적용하기

 

 

좋은 개발자의 비밀, 실력 향상과 성공을 위한 지침 - 부트캠프의 중요성

좋은 개발자의 비밀, 실력 향상과 성공을 위한 지침 - 부트캠프의 중요성 오늘날의 디지털 시대에서는 개발자들이 핵심 역할을 수행하며 현대 사회를 움직이게 하는 중요한 역할을 맡고 있습니

lemonlog.tistory.com

 

굵게, 기울임, 밑줄 등의 폰트 스타일을 적용하려면 다음과 같이 작성합니다.

**굵은 글씨**
*기울임*
~~취소선~~

 

 

마크다운 폰트 스타일

 

 

5. 링크 추가하기

하이퍼링크를 추가하려면 다음과 같이 작성합니다.

[GitHub](https://github.com)

 

마크다운 링크

 

위 코드는 "GitHub"이라는 텍스트에 GitHub 링크를 추가합니다.

 

 

6. 이미지 삽입하기

 

 

이미지를 삽입하려면 다음과 같이 작성합니다.

![레몬사진](https://newswave25.com/wp-content/uploads/2021/12/Screenshot-2021-12-08-113111.png)

 

레몬 이미지

 

위 코드는 이미지 설명과 링크된 이미지를 추가합니다.

 

 

끝으로

 

GitHub 마크다운은 다양한 기능을 제공하여 문서 작성을 효과적으로 할 수 있습니다. 이러한 기능들을 활용하여 깔끔하고 가독성 있는 문서를 작성해보세요.

 

▼ 아래 글도 읽어보세요! ▼

 

 

Git과 Github 개념 및 차이점

Git과 Github 개념 및 차이점 코드 개발에 있어서 가장 먼저 배운 것은 Git과 Github 사용법 이었습니다. 그만큼 개발보다 중요한 '협업'을 위해서라면 필수적으로 사용할 줄 알아야 하는 Git과 Github의

lemonlog.tistory.com

 

 

gitignore 사용법 - 소스코드 제공 사이트 소개 (gitignore.io)

gitignore 사용법 - 소스코드 제공 사이트 소개 (gitignore.io) 소프트웨어 개발 프로젝트를 진행하면 수많은 파일과 폴더가 생성되고 수정됩니다. 그런데 Git 저장소에는 모든 파일을 포함시키면 프로

lemonlog.tistory.com