마크다운과 사용법

이건희·2023년 3월 8일
0

마크다운(MarkDown)

마크다운(MarkDown)이란?


  • Markdown은 텍스트 기반의 마크업언어로 2004년 존그루버에 의해 만들어졌으며 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능하다. 특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다. 마크다운이 최근 각광받기 시작한 이유는 깃헙(https://github.com) 덕분이다. 깃헙의 저장소Repository에 관한 정보를 기록하는 README.md는 깃헙을 사용하는 사람이라면 누구나 가장 먼저 접하게 되는 마크다운 문서였다. 마크다운을 통해서 설치방법, 소스코드 설명, 이슈 등을 간단하게 기록하고 가독성을 높일 수 있다는 강점이 부각되면서 점점 여러 곳으로 퍼져가게 된다.

마크다운 작성법(문법)


헤더작성법

  • 큰 제목 작성법

    This is the Header
    ============

  • 작은 제목 작성법

    This is the Header

    -----------------

글머리 작성법

  • 1~6까지만 지원

    #This is Header
    ##This is Header
    ###This is Header
    ####This is Header
    #####This is Header
    ######This is Header

  • 적용 결과

    This is Header

    This is Header

    This is Header

    This is Header

    This is Header
    This is Header

    ########This is header - 7개부터는 적용이 되지 않은 모습


BlockQuote

  • 이메일에서 사용하는 > 를 사용한다.

    > This is Header
    >>This is Header
    >>>This is Header

  • 실행 결과

    This is Header

    This is Header

    This is Header

  • 안에서는 이와 같이 다른 마크다운 기호를 포함할 수 있다.

목록

순서 있는 목록

  • 숫자와 점(1.) 을 사용한다.

    1. 1번
    2. 2번
    3. 3번
  • 순서가 뒤죽박죽이여도 순서대로 정렬된다.

    1. 1번
    2. 3번
    3. 2번

순서가 없는 목록

  • 글머리 기호 (*, +, -)을 지원
    • * 사용하는 글머리
    • + 사용하는 글머리
    • - 사용하는 글머리

수평선

  • 아래의 예시들은 모두 수평선을 만든다.

    - - -
    * * *
    *
    *****

    ----------------------------

  • 적용 예시







강조

  • 글을 강조하기 위해 사용되며 크게 5가지가 있다.

    *single asterisks*
    _single underscores_
    **double asterisks**
    __double underscores__
    ~~cancelline~~

  • 적용 예시

    single asterisks
    single underscores
    double asterisks
    double underscores
    cancelline


줄바꿈

  • 3칸 이상의 띄어쓰기로 줄바꿈을 할 수 있다.

    문장 끝에 3칸 이상 띄어쓰기를 하면 줄바꿈이 된다.
    이렇게


코드 블록

  • Code를 위해 블록 지정이 가능하다

    ```java(변경 가능)
    코드 내용
    ```

  • 적용 내용
    System.out.println("이는 적용 예시이다");
    System.out.println("java 대신 다른 언어도 사용 가능하다");

추후 업데이트 예정

profile
백엔드 개발자가 되겠어요

0개의 댓글

관련 채용 정보