Markdown 문서 작성 규칙

문서 작성 규칙을 잘 따르면 문서를 찾기 쉽고 유지보수가 편하다. 더 좋은 문서를 만들기 위한 방법을 늘 고민하고 제시하길 바란다.

1. 텍스트

  • 문서의 제목은 #으로 시작한다. H1 사용.
  • H1, 즉 #으로 시작하는 제목은 문서에 하나만 존재한다.
  • 문서의 부제목, 즉 단락별 제목은 ##을 사용한다. H2 사용.
  • 부제목의 부제목이 있다면 마찬가지로 ###을 사용한다. H3 사용.
  • 제목이나 부제목 다음에는 무조건 빈줄을 넣는다.
# 제목

한 줄 띄고 내용을 적는다.

## 부제목

부제목도 한 줄 띄고 내용을 적는다.

### 하위제목 1

- 리스트 1
- 리스트 2

### 하위제목 2

![마크다운 치크시트](img/markdown-cheat-sheet.png))
> 마크다운 치트시트

- 리스트 1
- 리스트 2
    - 리스트 2-1
    - 리스트 2-2

2. 이미지

  • 이미지를 추가할 경우에는 문서의 동일 디렉토리에 img디렉토를 만들고 고유한 이름으로 저장한다.
  • 이미지 파일명은 영문소문자를 사용하고 png 포맷을 사용한다.
  • 이미지 링크는 상대 경로를 사용한다.
![마크다운 치크시트](img/markdown-cheat-sheet.png))

참고자료