📘 Docusaurus 문서 작성 가이드

hookdle 프로젝트의 문서를 어떻게 작성하는지에 대해 간단히 소개하는 가이드입니다.

Docusaurus를 완벽하게 아는 건 아니지만,, 그냥 일단 한 번 끄적여보겠습니다. 더 궁금하면 공식문서 ㄱㄱ

https://docusaurus.io/docs

🏗 기본 설명

• Docusaurus는 React 기반의 정적 사이트 생성기입니다.
• 프레임워크이기 때문에 폴더 구조에 따라 자동으로 페이지가 구성됩니다.
• 문서는 Markdown(.md) 파일로 작성하며, React 문법도 일부 사용할 수 있습니다.
• 오른쪽 사이드바는 Markdown의 ##, ### 같은 헤더 수준에 따라 자동 생성됩니다.

📁 현재 폴더 구조 소개

아래는 현재 문서 디렉토리 구조입니다.

docs/ 내부에서 우리가 작성한(할) 문서는 /docs/react 아래에 위치합니다.

docs/
├── docs/
│ ├── hooks/
│ │    └── useBooleanState.md   # 훅별 문서
│ └── getStarted.md       # 문서 작성 시작 가이드
├── src/
│ ├── components/         # React 컴포넌트
│ ├── css/                # CSS 파일
│ └── pages/              # 일반 페이지들 (JSX + MDX 가능)
│ ├── index.tsx           # 루트 경로 페이지
│ └── introduce.md        # 기여자 소개 등 문서
├── docusaurus.config.ts  # 설정 파일
├── sidebars.ts           # 사이드바 메뉴 설정
└── package.json