마크다운 수업 정리

마크다운이란?

일반 텍스트에 몇 가지 기호를 섞어 문서의 구조를 표현하는 표기 방식이다.
개발자들이 사용하기 좋은 형식이라고 한다.
GitHub 홈페이지의 README 부분도 마크다운으로 작성하며 노션 역시 마크다운으로 작성 된다.
확장자는 .md 이다.

마크다운에는 코드, 링크, 이미지, 짧은 영상, 각종 다이어그램(클래스 다이어그램, 상태 다이어그램 등)이 들어갈 수 있고
텍스트 편집기로 확인 했을 때 HTML처럼 복잡해 보이지 않는다.
다만 화면에 렌더링 될 때에는 렌더러에 따라서 색상이나 형식이 달라보일 수 있다.

선 긋기에 대한 설명

텍스트 작성 중 빈 칸에 --- 를 작성하면 해당 줄은 렌더러에서 아래와 같이 선으로 표시된다.

제목 작성 방법에 대한 설명

제목 표시는 # 으로 표시하며 #의 수에 따라 대제목, 중제목, 소제목처럼 사용 할 수 있다.
단 #을 한번만 쓰는 것은 일반적으로 문서 전체에 대한 제목으로 쓰여서 한번만 쓰는 경우가 많다고 한다.

# 대제목(1단계 제목)
## 중제목(2단계 제목)
### 소제목(3단계 제목)
이와 같이 입력 하면 렌더러에서는 아래와 같이 화면에 출력 된다.

대제목(1단계 제목)

중제목(2단계 제목)

소제목(3단계 제목)

목록형 작성에 대한 설명

목록형은 순서가 없는 목록형과 순서가 있는 목록형으로 나눌 수 있는데
순서가 없는 목록형은 - 를 사용하고 순서가 있는 목록형은 1. 을 사용한다.

1. 순서가 있는 목록형 테스트
- 순서가 없는 목록형 테스트
이와 같이 입력하면 아래와 같이 출력 된다.

1. 순서가 있는 목록형 테스트

• 순서가 없는 목록형 테스트

목록형 생성 후 엔터를 입력하면 줄이 바뀌면서 새로운 목록형이 자동으로 생성되며
내용이 없는 상태로 한번더 엔터를 입력하거나 백스페이스를 입력하면 해당 줄의 목록형 형식이 사라진다.
또한 목록형의 하위에도 새로운 목록형을 생성 할 수 있으며
새로 생성된 목록형에 커서를 두고 탭을 누르면 들여쓰기가 되면서 하위 목록형이 생성된다.
이 때 형식에 상관없이 순서가 있는 목록형의 하위에 순서가 없는 목록형을 생성할 수도 있고, 그 반대도 가능하다

1. 순서가 있는 목록형
(탭 입력) - 순서가 없는 목록형
- 순서가 없는 목록형
(탭 입력) 1. 순서가 있는 목록형
이와 같이 입력하면 아래와 같이 출력 된다.

1. 순서가 있는 목록형

• 순서가 없는 목록형

• 순서가 없는 목록형

  1. 순서가 있는 목록형

강조 표시에 대한 설명

강조표시는 문장을 굵게 또는 기울게 아니면 굵으면서 기울게 할 수 있는 기능을 말하는데 * 또는 _ 를 사용하게 된다.

*기울게*, _기울게_
**굵게**, __굵게__
***굵고 기울게***, ___굵고 기울게___
이와 같이 입력 하면 아래와 같이 출력 된다.

기울게, 기울게
굵게, 굵게
굵고 기울게, 굵고 기울게

줄바꿈에 대한 설명

마크다운에서 내용을 입력 후 엔터를 입력하면 다음 문단으로 넘어가게 되는데 한 문단 안에서 줄바꿈을 할 수 있는 기능이 있다.

이와 같이 그냥 엔터를 입력할 경우 이전 위치와 서로 다른 문단으로 취급하는 반면 쉬프트 + 엔터를 누를경우
이와같이 글자간 높이 간격도 달라지고 서로 한 문단으로 취급 된다.

쉬프트 + 엔터 외에도 .. \
을 사용하는 방법도 있으나
은 지원을 하지 않는 렌더도 있으니 사용은 비추천한다.
만약
을 통하여 줄바꿈을 해놓았는데
을 지원하지 않는경우 화면에 그대로 출력되어 일일이 삭제해야한다.

마크다운 내 코드를 입력할 때에 대한 설명

마크다운에 코드를 입력할때 사용하는 방법이 2가지가 있는데 하나는 인라인 코드를 넣는 경우이고 다른 하나는 코드를 블록으로 넣는경우이다.

- 인라인 코드를 넣을 경우 `int damage = totalDamage * buffRate;` 이와같이 입력 해야 하며
- 코드를 블록으로 넣을 경우 펜스(```)를 만들어서 그 안에 넣어야 한다.
'```csharp' <- 이처럼 펜스 이후에 언어 지정까지 해주면 해당 언어에 맞게 포멧이 정해진다.
using UnityEngine;

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

이와 같이 입력하면 아래와 같이 출력 된다.

• 인라인 코드를 넣을 경우 int damage = totalDamage * buffRate; 이와같이 입력 해야 하며
• 코드를 블록으로 넣을 경우 펜스(```)를 만들어서 그 안에 넣어야 한다.

using UnityEngine;

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

인용문에 대한 설명

인용문은 일반적으로는 잘 사용하지 않지만 혹시라도 출처가 있는 문장을 옮기게 되었을 때(예를들어 메뉴얼 같은) 사용하면 된다.
' > '를 입력 후 내용을 적으면 아래와 같이 출력된다.

인용문 내용 작성.

여러 줄을 입력하려면 각 줄 앞에 >를 붙이면 된다.

링크와 이미지에 대한 설명

많이 사용하게 될 기능이다. 링크는 다른 문서나 웹 주소로 이동하는 표시이고 이미지는 그림을 문서 안에 표시하는 기능이다.
두 문법의 형태는 거의 동일하며 링크 문법의 앞에 느낌표를 붙인 모양이 이미지 문법이다.
링크에는 인라인 링크, 참조 링크, 자동 링크 등이 있으며 같은 문서 안의 다른 제목으로 이동하거나
상대경로를 통해 다른 저장소 안의 다른 파일에 연결할 수 도 있다.
대괄호에는 표시할 글자를, 소괄호에는 주소를 적으면 된다.
아래는 각각 링크와 이미지에 대한 예시이다.

링크 문법
[Unity 공식 문서](https://docs.unity3d.com/)

이미지 문법
![플레이 화면](images/gameplay.png)

표에 대한 설명

마크다운에서도 표를 사용 할 수 있다. 파이프 '|'로 칸을 나누며 첫 번째 줄은 열의 이름이고
두번째 줄은 '-'로 이루어진 구분행이며, 셋째줄 부터 내용이다.

| 컴포넌트 | 역할 |
|---|---|
| Transform | 위치·회전·크기 |
| Rigidbody | 물리 연산 |
| Collider | 충돌 판정 |
표를 입력하는 예시이며 아래와 같이 표시된다.

체크박스

GitHub나 노션에서는 체크박스를 만들 수 있다. 다른 렌더러의 경우 당 기능을 지원하지 않는 렌더러도 있다.

- [x] 플레이어 이동 구현
- [x] 장애물 생성
- [ ] 점수 표시
- [ ] 사운드 추가
x는 체크 표시이다.
위와 같이 입력하면 아래와 같이 출력 된다.

• 플레이어 이동 구현
• 장애물 생성
• 점수 표시
• 사운드 추가

다이어그램

마크다운에 다이어그램을 작성하는 기능이다. mermaid를 사용하며 mermaid는 텍스트로 도표를 기술하는 표기법의 이름이다.
링크나 이미지처럼 유용한 기능이다. 아래 예시는 플로어차트에 대한 예시이다.

flowchart LR
    A[시작] --> B{조건}
    B -->|참| C[처리]
    B -->|거짓| D[종료]