EDU/codeIt

마크다운 문법

이앤지 2021. 9. 30. 17:56

https://ko.wikipedia.org/wiki/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4

 

마크다운 - 위키백과, 우리 모두의 백과사전

 

ko.wikipedia.org

 

깃허브에서 프로젝트를 열면 README.md 파일이 만들어지는데

이는 프로젝트를 소개함과 동시에 설명서 역할을 해줘서

가독성이 매우매우매우 중요하다.

 

마크다운은 특정 규칙에 맞게, 간단한 텍스트만으로 어떤 표시를 해두면,

그것이 자동으로 HTML 태그로 전환되도록 약속된 문법이다.

그래서 그냥 텍스트만으로도 내용의 디자인을 예쁘게 만들 수 있다.

주피터 노트북에서도 Code 와 Markdown을 적절히 섞어써줬다.

아래 사이트는 실시간으로 Markdown 적용해볼 수 있다.

https://dillinger.io/

 

Online Markdown Editor - Dillinger, the Last Markdown Editor ever.

Make something great today!

dillinger.io

https://stackedit.io/app

 

StackEdit

 

stackedit.io

 

 

 

 

사용예시

https://gist.github.com/ihoneymon/652be052a0727ad59601

 

마크다운(Markdown) 사용법

마크다운(Markdown) 사용법. GitHub Gist: instantly share code, notes, and snippets.

gist.github.com

https://guides.github.com/features/mastering-markdown/

 

Mastering Markdown · GitHub Guides

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform. What you will learn: How the Markdown format makes styled collaborative editing easy How Markdown differs from traditional formatting approaches How t

guides.github.com

 

더보기

제목

#를 사용하여 단계별로 제목을 표현할 수 있습니다.

#을 하나만 쓰면 1단계 제목이고, # 을 4개 사용하면 4단계 제목이 됩니다. 단계가 높아질수록 글자 크기가 작아집니다.

# 이것은 1단계 제목입니다. ## 이것은 2단계 제목입니다. ### 이것은 3단계 제목입니다. #### 이것은 4단계 제목입니다. 이것은 일반 글입니다.

 

이것은 1단계 제목입니다.

이것은 2단계 제목입니다.

이것은 3단계 제목입니다.

이것은 4단계 제목입니다.

이것은 일반 글입니다.

 

번호가 있는 목록

아래처럼 적으면 번호가 있는 목록(리스트)을 만들 수 있습니다.

1. 첫 번째 할일입니다. 2. 두 번째 할일입니다. 3. 세 번째 할일입니다.

  1. 첫 번째 할일입니다.
  2. 두 번째 할일입니다.
  3. 세 번째 할일입니다.

번호가 없는 목록

숫자 대신 *을 사용하면, 번호가 없는 목록을 만들 수도 있습니다.

* 번호가 없는 목록입니다. * 번호가 없는 목록입니다. * 번호가 없는 목록입니다.

  • 번호가 없는 목록입니다.
  • 번호가 없는 목록입니다.
  • 번호가 없는 목록입니다.

줄 바꿈

아래와 같이 입력해 봅시다.

경찰청 철창살은 외철창살이냐 쌍철창살이냐? 내가 그린 기린 그림은 잘 그린 기린 그림이고 네가 그린 기린 그림은 잘 못 그린 기린 그림이다. 신인 샹송 가수의 신춘 샹송 쇼.

경찰청 철창살은 외철창살이냐 쌍철창살이냐?내가 그린 기린 그림은 잘 그린 기린 그림이고 네가 그린 기린 그림은 잘 못 그린 기린 그림이다.신인 샹송 가수의 신춘 샹송 쇼.

그런데 실행된 값을 보면 줄 바꿈이 안 되어 있죠? 줄 바꾸기를 하려면 문장의 맨 끝에 Space 키를 두 번 눌러야 합니다.

경찰청 철창살은 외철창살이냐 쌍철창살이냐?vv 내가 그린 기린 그림은 잘 그린 기린 그림이고 네가 그린 기린 그림은 잘 못 그린 기린 그림이다.vv 신인 샹송 가수의 신춘 샹송 쇼.

경찰청 철창살은 외철창살이냐 쌍철창살이냐? 내가 그린 기린 그림은 잘 그린 기린 그림이고 네가 그린 기린 그림은 잘 못 그린 기린 그림이다. 신인 샹송 가수의 신춘 샹송 쇼.

문단 바꿈

문단을 바꾸는 효과를 위해서는 Enter 키를 두 번 눌러 주세요.

경찰청 철창살은 외철창살이냐 쌍철창살이냐? 내가 그린 기린 그림은 잘 그린 기린 그림이고 네가 그린 기린 그림은 잘 못 그린 기린 그림이다. 신인 샹송 가수의 신춘 샹송 쇼.

경찰청 철창살은 외철창살이냐 쌍철창살이냐?

내가 그린 기린 그림은 잘 그린 기린 그림이고 네가 그린 기린 그림은 잘 못 그린 기린 그림이다.

신인 샹송 가수의 신춘 샹송 쇼.

문자 강조

*와 _를 사용하면 글자를 꾸밀 수 있습니다.

이탈릭체는 *별표*나 _언더바_로. 볼드체는 **별표 두 개**나 __언더바 두 개__로. **별표와 _언더바_**를 섞어서. 취소선은 ~~물결~~로.

이탈릭체는 별표나 언더바로.

볼드체는 별표 두 개언더바 두 개로.

별표와 언더바를 섞어서.

취소선은 물결로.

링크

어떤 사이트로의 링크를 걸 수도 있습니다.

 

이미지

이미지를 추가할 수도 있습니다.

코드 블록

` 세 개로 “코드 블록”을 추가해 보세요. 언어도 지정해 줄 수 있습니다!

```python print('hello world!') for i in range(10): print(i) ``` print('hello world!') for i in range(10): print(i)

인라인 코드

``로 코드를 감싸면 “인라인 코드”를 쓸 수 있습니다.

값을 출력하고 싶으면 `print` 함수를 사용하면 되겠죠?

값을 출력하고 싶으면 print 함수를 사용하면 되겠죠?

구분선

---으로 구분선을 추가할 수 있습니다.

구분 선 위 --- 구분 선 아래

구분 선 위


구분 선 아래