5.0 KiB
5.0 KiB
title, description, sidebar, prev, next
| title | description | sidebar | prev | next | ||
|---|---|---|---|---|---|---|
| 콘텐츠 작성 표준 가이드 | Civil Engineering Lab 콘텐츠 작성 표준 가이드 |
|
false | false |
본 문서는 Civil Engineering Lab의 자료를 작성할 때 준수해야 할 기능적 규칙과 내용 작성 가이드를 정의합니다. 모든 작성자는 이 기준을 따라 문서를 작성해 주시기 바랍니다.
1. 디렉토리
C.E.L 구조에 대한 내용(상단탭/우측 카테고리/서브카테고리)
2. 본문 구조 및 목차
본문의 구조는 헤더(Headings) 태그(##)를 통해 결정됩니다. 헤더를 올바르게 작성해야 우측 목차가 자동으로 생성되어 열람자가 내용을 쉽게 파악할 수 있습니다.
2.1 문서 설정
문서의 가장 첫 줄에는 반드시 페이지의 정보를 담은 프론트매터(Frontmatter)를 작성해야 합니다.
---
title: 페이지 제목 # 화면 최상단 및 좌측 메뉴에 표시
sidebar:
order: 10 # 좌측 메뉴 순서 (숫자가 낮은 순서대로 표시됨)
---
### 2.2 제목 및 목차 계층 구조
우측 목차(On this page)는 H2(##)부터 H3(###)까지 수집하여 표시합니다. 문서의 구조를 쉽게 파악할 수 있도록 번호 매기기를 권장하며, 각 헤더의 역할과 목차 표시 여부는 아래와 같습니다.
| 마크다운 | 레벨 | 번호 규칙 | 목차 표시 | 역할 |
|---|---|---|---|---|
# |
H1 | (사용 금지) | X (미표시) | 문서 제목 (Frontmatter title로 대체) |
## |
H2 | 1., 2. | O (1단계) | 대주제 (가장 큰 챕터) |
### |
H3 | 1.1., 1.2. | O (2단계) | 중주제 (하위 섹션) |
#### |
H4 | 1.1.1. | O (3단계) | 소주제 (본문 내 상세 설명용) |
:::danger[작성 금지 사항]
#(H1) 사용 금지: 페이지 제목은 자동으로 생성되므로 본문에 쓰지 않습니다.- 단계 건너뛰기 금지:
##(1.) 없이 바로###(1.1.)을 쓰면 목차 구조가 깨집니다. :::
**제목 구조 예시** ```markdown ## 1. DX에 대한 인식 (H2)
1.1 국내 인식 (H3)
1.1.1 발주처 (H4)
<br/>
### 2.3 문단 및 줄 바꿈
마크다운에서는 엔터 키 한 번으로는 줄이 바뀌지 않습니다. 상황에 따라 아래 두 가지 방법을 구분해서 사용하세요.
* **문단 나누기** : 내용의 호흡이 바뀔 때는 **빈 줄(Enter 2번)** 을 넣어 확실하게 띄웁니다.
* **단순 줄 바꾸기** : 같은 문단 안에서 줄만 바꿀 때는 문장 끝에 **공백 2칸(Space bar)** 을 입력합니다.
<br/>
**문단 바꿈 작성 예시**
```markdown
1. 엔터를 한 번만 쳤을 때 (줄바꿈 X)
윗줄 내용입니다.
아랫줄 내용입니다.
-> 결과: 한 줄로 쭉 이어져서 나옵니다.
2. 문단을 나눌 때 (Enter 2번)
윗줄 내용입니다.
아랫줄 내용입니다.
-> 결과: 위아래 간격이 넓게 벌어집니다.
**줄바꿈 작성 예시** ```markdown 1. 줄만 바꿀 때 (Space 2번) 윗줄 내용입니다. (여기 뒤에 공백 2칸 있음) 아랫줄 내용입니다. -> 결과: 간격 없이 바로 아랫줄로 내려갑니다. ```
### 2.4 목록 내용을 나열할 때는 기호나 숫자를 사용하여 가독성을 높일 수 있습니다.
- 순서 없는 목록 : - (하이픈) 또는
*(별표)를 사용합니다. - 순서 있는 목록 :
1.과 같이 숫자와 점을 사용합니다.(제목과 달리 본문 크기로 적용됩니다.) - 하위 목록(들여쓰기) :
Tab키를 눌러 들여쓰기 합니다.
**[목록 작성 예시]** ```markdown 1. 주요 공정 (Space 2번) - (Tab) 터파기 - (Tab) 기초 타설 ```
### 2.4 주제 구분 내용의 흐름이 크게 바뀌거나 섹션을 시각적으로 분리할 때 사용합니다.
- 사용법: 빈 줄에 하이픈 3개(
---)를 입력합니다. - 사용처:
##등 내용이 바뀔 때 사용합니다---이후에<br/>을 넣어 주제간 공백을 둡니다. - 주의사항: 위아래로 빈 줄을 두어야 선이 깔끔하게 그려집니다.
📝 작성 예시
이전 주제에 대한 설명이 끝났습니다.
---
(가로선이 생기며 내용이 분리됩니다)
여기서부터는 새로운 주제입니다.
---
3. 시각 자료 및 수식
이미지, 링크, 표, 수식 등에 대한 설명
Math / KaTeX 사용법
-
인라인 수식:
E = mc^2 -
블록 수식:
\int_{-\infty}^{\infty} e^{-x^2} \, dx = \sqrt{\pi}
복잡한 매크로나 패키지는 KaTeX에서 지원되지 않을 수 있으니, 렌더링이 깨지면 대체 표기나 단순화된 수식을 권장합니다.