26.09.23 학습

Markdown 학습 정리

학습 목표

• Markdown이 무엇이고 어떤 설계 의도로 만들어졌는지 설명할 수 있다.
• 상황에 맞는 Markdown 문법을 사용해 문서를 작성할 수 있다.

1. Markdown이란?

Markdown은 일반 텍스트에 몇 가지 기호를 사용해 문서의 구조와 서식을 표현하는 문법이다. 2004년 John Gruber가 만들었으며, 가장 중요한 설계 목표는 작성한 원문 자체도 읽기 쉬워야 한다는 것이다.

HTML은 <h1>제목</h1>처럼 태그로 내용을 감싸야 하고, 워드프로세서는 문서 내부에 별도의 서식 정보를 저장한다. 반면 Markdown은 다음과 같이 작성한다.

# 제목

**중요한 내용**과 `코드`를 작성할 수 있다.

서식이 적용되지 않은 상태에서도 제목이나 강조의 의도를 쉽게 파악할 수 있다는 점이 Markdown의 특징이다.

Markdown 파일은 주로 .md 확장자를 사용하며, GitHub나 Obsidian 같은 프로그램이 Markdown 문법을 HTML 등의 화면 형태로 변환한다. 이 과정을 렌더링, 변환하는 프로그램을 렌더러라고 한다.

2. Markdown의 표준과 확장

Markdown에는 하나의 통일된 문법만 존재하지 않는다.

• 원본 Markdown: John Gruber가 2004년에 만든 최초의 문법
• CommonMark: Markdown 문법의 모호함을 줄이기 위해 만들어진 표준
• GFM: GitHub가 CommonMark에 표, 작업 목록 등을 추가한 확장
• Obsidian Markdown: 위키링크와 하이라이트 등 Obsidian 전용 문법을 포함

따라서 같은 .md 파일이라도 어떤 프로그램에서 열었는지에 따라 결과가 다를 수 있다. 여러 환경에서 사용할 문서라면 표준 Markdown 문법을 우선 사용하는 것이 좋다.

3. 자주 사용하는 기본 문법

제목

#의 개수로 제목의 단계를 표현한다. # 뒤에는 공백을 넣어야 한다.

1단계 제목

2단계 제목

3단계 제목

제목은 글자의 크기를 조절하는 기능이 아니라 문서의 구조를 만드는 기능이다. 따라서 제목 단계를 건너뛰지 않고 순서대로 작성하는 것이 좋다.

문단과 줄바꿈

빈 줄을 넣으면 새로운 문단이 시작된다.

첫 번째 문단입니다.

두 번째 문단입니다.

같은 문단 안에서 줄만 바꾸려면 줄 끝에 백슬래시를 사용할 수 있다.

첫 번째 줄입니다.\
두 번째 줄입니다.

일반적으로 단순히 Enter를 한 번 누르는 것만으로는 렌더링 결과에서 줄바꿈이 적용되지 않을 수 있다.

강조

별표 한 개는 기울임, 두 개는 굵게 표시한다.

*기울임*
**굵게**
***굵은 기울임***

특수 기호를 그대로 표시하고 싶을 때는 앞에 백슬래시를 붙인다.

\*별표를 문자로 표시\*

목록

순서가 중요하지 않은 내용은 순서 없는 목록을 사용한다.

- 플레이어 이동
- 장애물 생성
- 점수 계산

순서나 절차가 중요한 내용은 순서 있는 목록을 사용한다.

1. 저장소를 내려받는다.
2. Unity Hub에서 프로젝트를 연다.
3. 프로젝트를 실행한다.

목록 안에 하위 목록을 넣을 때는 들여쓰기를 사용한다.

4. 코드 작성

짧은 코드는 백틱 하나로 감싼다.

PlayerController.cs 파일을 생성한다.

여러 줄의 코드는 코드 블록으로 작성한다. 여는 백틱 뒤에 언어를 지정하면 문법 강조가 적용된다.

```csharp
using UnityEngine;

public class Player : MonoBehaviour
{
    private void Start()
    {
    }
} 

대표적인 언어 지정자는 다음과 같다.

- C#: `csharp`
- JavaScript: `javascript`
- JSON: `json`
- Markdown: `markdown`
- 명령어: `bash`

코드 블록 안에 또 다른 백틱 세 개가 들어가야 한다면 바깥쪽 펜스를 백틱 네 개 이상으로 작성해야 한다.

5. 인용문과 구분선

인용문은 > 기호를 사용한다.

Markdown은 읽기 쉬운 문서를 만들기 위한 문법이다.

구분선은 ---처럼 하이픈을 세 개 이상 사용한다.

설치

설치 방법을 설명한다.

실행

실행 방법을 설명한다.

다만 구분선은 너무 많이 사용하면 문서가 잘게 나뉘므로 꼭 필요한 곳에만 사용하는 것이 좋다.

6. 링크와 이미지

링크는 대괄호에 표시할 글자를, 소괄호에 주소를 작성한다.

[디벨로켓 홈페이](https://www.kiweb.or.kr/main/)

이미지는 링크 앞에 !를 붙인다.

![게임 플레이 화면]()

이미지가 표시되지 않을 때를 대비해 대체 텍스트를 작성하는 것이 좋다.

Mermaid 다이어그램

다만 표, 작업 목록, 다이어그램, 수식 등은 모든 Markdown 환경에서 지원되는 것은 아니다.

7. Markdown 작성 시 주의할 점

• 제목의 # 뒤에는 공백을 넣는다.
• 제목 단계를 건너뛰지 않는다.
• 문단을 나눌 때는 빈 줄을 넣는다.
• 목록 기호 뒤에는 공백을 넣는다.
• 코드에는 인라인 코드와 코드 블록을 구분해서 사용한다.
• 코드 블록에는 가능한 한 언어를 지정한다.
• 이미지에는 대체 텍스트를 작성한다.
• 표 안에서 |를 사용하려면 \|로 이스케이프한다.
• 여러 Markdown 환경에서 사용할 문서는 확장 문법 사용에 주의한다.