MarkDown Guide

code
Author

CGAlpha

Published

2023-11-13

Getting Started

An overview of Markdown, how it works, and what you can do with it.

Markdown Syntax

How to Write in Markdown - Syntax & Use Cases

1. Definition

README파일이나 온라인 문서, 혹은 일반 텍스트 편집기로 문서 양식을 편집할 때 쓰입니다.

존 그루버는 2004년에 문법 면에서 에런 스워츠와 중대한 협업을 통해 마트다운 언어를 만들었으며, 사람들이 일기 쉽고 쓰기 쉬운 플레인 텍스트 포맷을 사용하여 쓸 수 있으면서 구조적으로 유효한 HTML로 선택적 변환이 가능합니다.John Gruber (DaringFireball).

2. Markdown Pros

  • 읽기 쉽다. 확실히 마크다운은 다른 마크업 언어에 비해 가독성이 좋습니다. 문법도 단순하고, HTML은 작성하면서 브라우저에서 어떻게 보여 질지 예상하는게 쉽지 않지만, 마크다운을 사용한 텍스트는 브라우저에 보여질 내용을 쉽게 상상할 수 있습니다.
  • 익히기 쉽다. 존 그루버는 사람들이 많이 사용하는 것은 마크다운으로 사용하고, 복잡한 것은 HTML로 사용하기 바랬습니다. 그래서 문법이 매우 간단합니다. 그리고 마크다운으로 글을 작성할 때, 제한적인 기능 몇 개를 제외하고 HTML을 함께 사용해도 상관없습니다.
  • 모바일 친화적이다. 단순히 텍스트만 작성하는 것이 아닌 에디터를 이용해 모바일로 작성하는 것은 쉽지 않습니다. 하지만 마크다운을 이용하면 모바일에서도 태그로 쉽게 서식을 넣을 수 있어서, 에디터보다 훨씬 편합니다.

3. Markdown Cons

  • 문법이 너무 단순하다. 문법이 단순한 나머지 결국에는 HTML을 써야하는 경우가 생깁니다. 테이블 정렬 기능은 있지만, 이미지 정렬 기능이 없어서 HTML의 img 태그를 사용해야합니다. 태그에 클래스 지정등이 불가능하기 때문에, 클래스나 id를 지정하려면 HTML을 사용해야합니다.
  • 표준이 없어 사용자마다 문법이 상이할 수 있다. 문법이 단순하다 보니, 이러한 점을 해결하기 위해 확장문법들이 생겼고, 이러한 것들 때문에 한 곳에서 작동하는 마크다운 문서가 다른 곳에서는 잘 작동하지 않는 경우가 생기기도 합니다.

4. Basic Markdown Syntax

이건 인용하는데 사용하는 코드입니다.

오늘의 할일

  1. git 공부
  2. 프로젝트 수정

점 종류

  • 작대기
    • 점
      • 더하기

코드 작성

python 코드

def greet(name):
    print(f"Hello, {name}!")
def hello():
    print("hello world")

코드 종료

참조 링크

이미지 추가

Concrete_building

5. Font Color

red

파랑

초록

Strong

그레이

노랑

6. Font Bold / Italic / Underline

  • 기울기라 적으면 기울기처럼 글자를 기울일 수 있습니다.

  • 굵게라 적으면 굵게처럼 글자를 굵게 표시할 수 있습니다.

  • 굵게라 적으면 굵으며 기운처럼 글자를 굵으면서도 기울게 표시할 수 있습니다.

  • 밑줄라 적으면 밑줄처럼 밑줄을 그을 수 있습니다.

    (취향에 따라 * 표시 대신 _(언더라인)으로 대체할 수 있습니다)