콘텐츠로 이동

MkDocs 문법

문단제목(Heading)

1~6단계까지 설정가능
1단계가 제일 크고, 6단계가 제일 작다.
단계에 따라서 자동으로 목차가 생성된다. 

1
2
3
4
5
6
# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6

글자모양

굵게(Bold)

굵음은 별표 2개로 감싸면 된다. 

1
**굵음**

기울임(Italic)

기울기는 별표 1개로 감싸면 된다. 

1
*기울기*

밑줄(Underline)

밑줄은 <ins>태그로 감싸면 된다. 

1
<ins>밑줄</ins>

취소선(Strikethrough)

취소선은 <del>태그로 감싸면 된다. 

1
<del>취소선</del>

개행 및 문단

개행과 문단은 서로 다르다!
시각적으로는 줄간격이 다른것으로 확인할 수 있다.

개행(Line Break)

1
2
*.md파일은 개행을 인식하지 않으므로,  
개행을 할 경우 **줄끝에 공백을 2개 삽입**해야한다.
.md파일은 개행을 인식하지 않으므로,
개행을 할 경우 줄끝에 공백을 2개 삽입*해야한다.

문단(Paragraph)

1
2
3
**Enter키**을 이용하여,

*.md파일 내부에서 2번 개행하는 것은 **문단분리**이다.
Enter키을 이용하여,

.md파일 내부에서 2번 개행하는 것은 문단분리*이다.

가로줄(Horizontal Line)

가로줄을 넣는 방법은 여러가지가 있다.
단, 새로운 문단으로 시작해야한다.

1
2
3
4
5
---
- - -
***
* * *
*****

목록

목록의 앞에 공백을 4번 넣으면 하위 단락이 된다.
단, 새로운 문단으로 시작해야한다.

순서가 없는 목록(Unordered List)

  • 별표로 해도 되고
  • 대시로 해도 된다
    • 단 개별 문단으로 시작해야한다. 
      1
2
3
      * 별표로 해도 되고
- 대시로 해도 된다
    - 단 개별 문단으로 시작해야한다.

순서가 있는 목록(Ordered List)

모든 항목을 1. 로 맞추어도 상관없으며,
추후 수정을 용이하게 하기 위해서 1. 로 작성을 권장한다.

  1. 첫번째
  2. 두번째
  3. 세번째
  4. 네번째
    1. 4-1
  5. 다섯번째 
    1
2
3
4
5
6
    1. 첫번째
1. 두번째
3. 세번째
6. 네번째
    1. 4-1
5. 다섯번째

인용문(Blockquote)

  • 기본

    인용문은 특정 설명등을 강조할 때 사용됩니다.

1
>인용문은 특정 설명등을 강조할 때 사용됩니다.
  • 여러줄

    인용문은
    이런식으로
    여러줄로 작성할 수도 있습니다.

1
2
3
>인용문은  
>이런식으로  
>여러줄로 작성할 수도 있습니다.
  • 중첩

    목록처럼 인용문 내부에

    인용문을 더 넣을수도 있습니다 코드도 <b>가능</b>

1
2
3
>목록처럼 인용문 내부에
>>인용문을 더 넣을수도 있습니다.
>코드도 `<b>가능</b>`

코드

코드를 입력하고자 할 때는 다음과 같이 사용한다.

인라인 코드(Inline Code)

문장 중간에 삽입 가능한 *코드*는 다음과 같이 작성한다.

1
문장 중간에 삽입 가능한 `*코드*'는 다음과 같이 작성한다.

블록 코드(Block Code)

여러줄의 코드는 다음과 같이 작성한다. 

1
2
3
function() {
    console.log("Hello, World");
}

1
2
3
4
5
```JavaScript           <- 해당위치에 어떤 언어인지 명시해두면, 지원하는 언어에 한하여 하이라이트가 적용된다.
function() {
    console.log("Hello, World");
}
```

표(Table)

  • 기본
첫번째 헤더 두번째 헤더 세번째 헤더
테이블 내용입니다. 테이블 내용입니다. 테이블 내용입니다.
내용 셀 내용 셀 내용 셀 
1
2
3
4
첫번째 헤더  | 두번째 헤더   | 세번째 헤더
------------ | ------------- | ------------
테이블 내용입니다. | 테이블 내용입니다. | 테이블 내용입니다.
내용 셀      | 내용 셀       | 내용 셀
  • 정렬

내용셀에 정렬을 적용하고 싶으면 다음과 같이 작성한다.

:--- ---: :---:
좌측 정렬 중앙 정렬 우측 정렬
테이블 내용입니다. 테이블 내용입니다. 테이블 내용입니다. 
1
2
3
4
:---         | ---:          | :---:
:----------- |:-------------:| -----------:
좌측정렬     | 중앙정렬      | 우측정렬
테이블 내용입니다. | 테이블 내용입니다. | 테이블 내용입니다.

미디어 삽입

상대경로로 작성시, 시작은 프로젝트 디렉터리의 docs디렉터리 부터이다.

링크

링크는 다른 문서도 적용할 수 있습니다.
외부링크는 http등을 붙여야 합니다. 

1
2
링크는 [다른 문서](setupGuide.md)도 적용할 수 있습니다.  
[외부링크](https://www.google.com)는 http등을 붙여야 합니다.

링크는 툴팁이 적용되는 주석과 같은 형태로도 사용할 수 있습니다.

1
2
[링크][testLink]는 툴팁이 적용되는 주석과 같은 형태로도 사용할 수 있습니다.
[testLink]: setupGuide.md "툴팁 메시지"

이미지 삽입

1
>![Screenshot](img/sample.jpeg)