문서 작성 가이드

이 가이드는 Git Static Doc Server 환경에서 문서를 작성하는 작성자를 위한 통합 매뉴얼입니다. 이 프로젝트에서 제공하는 특수 기능들을 활용하여 가독성 높은 문서를 작성하는 방법과 AI를 활용한 효율적인 문서 생성 팁을 담고 있습니다.

---

🚀 시작하기

모든 문서는 Markdown(.md) 형식을 사용합니다. 문서의 최상단에는 Frontmatter를 통해 메타데이터를 정의할 수 있으나, 이는 선택 사항입니다.

Frontmatter 설정 (선택 사항)

문서의 특정 속성(태그, 비밀번호 등)을 정의하고 싶을 때 사용합니다. 파일의 가장 처음에 기술합니다.

---
tags: [태그1, 태그2]
password: "1234"    # 비밀번호 설정 시 접근 제한
private: false      # true로 설정 시 목록에서 숨김
---

3. 각주 (Footnotes)

추가적인 설명이나 출처를 기재할 때 사용합니다. 본문에는 기호를, 하단에는 상세 내용을 작성합니다.

문장 뒤에 각주 표시를 합니다.^[1] 여러 개의 각주를 사용할 수도 있습니다.^[2]

---

✨ 특수 기능 활용하기

작성자의 의도를 명확하게 전달하기 위해 제공되는 특수 구문들입니다.

1. GitHub 스타일 알림 (Alerts)

중요한 정보나 주의사항을 시각적으로 강조할 때 사용합니다.

2. 코드 블록과 Monaco Editor

문서 내 모든 소스 코드는 Monaco Editor(VS Code의 핵심 엔진)로 렌더링됩니다. 우측 상단의 복사 버튼을 통해 간편하게 코드를 복사할 수 있습니다.

// 예시 코드: 가독성 높은 하이라이팅 지원
function welcome() {
  console.log("Welcome to Git Static Doc Server!");
}

3. 자동 목차 (ToC)

문서 내의 헤더(h1 ~ h6)를 분석하여 자동으로 목차를 생성합니다. 별도의 작업을 하지 않아도 화면 우측 또는 상단에 내비게이션이 배치됩니다.

4. PDF 다운로드 및 인쇄

작성한 문서는 우측 상단의 점 세 개(⋮) 메뉴를 통해 PDF로 다운로드할 수 있습니다. 이때 태그 정보나 내비게이션 등 불필요한 요소는 자동으로 제거되어 깔끔한 문서 형태로 출력됩니다.

---

🤖 AI 활용 가이드

AI(ChatGPT, Claude, Gemini 등)를 사용하여 문서를 작성할 때, 본 프로젝트의 규격에 맞는 고품질 결과물을 얻기 위한 프롬프트 예시입니다.

1. AI 사전 학습용 시스템 프롬프트

AI에게 문서 작성 규칙을 먼저 학습시키고 싶을 때 사용하세요.

당신은 'Git Static Doc Server'의 전문 기술 문서 작성자입니다. 
다음 규칙을 엄격히 준수하여 문서를 작성하십시오:

1. Frontmatter는 태그(tags)나 비밀번호(password)가 필요할 때만 작성할 것. 
   (title, date 등은 시스템이 본문에서 자동으로 추출하므로 본문 내용에만 집중할 것)
2. 강조가 필요한 정보는 GitHub 스타일 알림 구문을 사용할 것:
   - [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION]
3. 추가 설명이 필요한 경우 각주(`[^1]`) 기능을 활용할 것.
4. 모든 소스 코드는 언어 명시를 포함한 펜스 코드 블록(```)으로 감쌀 것.
5. 문장 체는 가독성이 좋은 구어체나 정중한 문체를 사용할 것.

2. 새 문서 구조 생성 프롬프트

주제만 던져서 구조를 잡고 싶을 때 유용합니다.

주제: [작성할 주제 입력]

위 주제에 대해 Git Static Doc Server 규격에 맞는 문서 초안을 작성해줘. 
- 본문의 첫 번째 줄은 # 주제 형태로 작성해줘.
- 관련 태그가 필요하다면 Frontmatter에 tags를 포함해줘.
- 중간에 [!TIP]과 [!WARNING]을 적절히 배치해줘.
- 어려운 용어에는 각주를 달아서 설명해줘.

---

📂 카테고리 관리

문서가 저장된 폴더 내에 blogcat.json 파일을 생성하여 해당 카테고리의 이름과 순서를 관리할 수 있습니다.

{
  "name": "카테고리 표시 이름",
  "seq": 10
}

• seq: 숫자가 낮을수록 메뉴 상단에 노출됩니다.

---

---

1. 각주에 대한 상세 설명입니다. 문서 최하단에 자동으로 모여 표시됩니다. ↩︎

2. 두 번째 각주입니다. ↩︎