실행 및 검증

이 저장소는 Education For Kids/Docs에 있는 독립 Docusaurus 문서 사이트입니다. Frontend와 Backend 코드는 sibling 저장소로 분리되어 있습니다.

Frontend 앱 실행

Frontend 저장소에서 실행합니다.

cd ../Frontend
npm install
npm run dev

Vite가 출력하는 로컬 주소에서 앱을 확인합니다.

Frontend 앱 검증

cd ../Frontend
npm test
npm run build

npm test는 시간 계산, 드래그 계산, 영어 시간 읽기 테스트를 실행합니다. npm run build는 TypeScript 타입 검사와 Vite 프로덕션 빌드를 실행합니다.

문서 사이트 실행

문서 사이트는 이 Docs 저장소에서 실행합니다.

npm install
npm run docs:sync
npm start

기본적으로 Docusaurus 개발 서버는 http://localhost:3000/에서 실행됩니다.

문서 사이트 검증

npm run docs:sync
npm run typecheck
npm run build

docs:sync는 ../Backend/docs 원본을 문서 사이트에 반영합니다. typecheck는 Docusaurus TypeScript 설정을 검사하고, build는 정적 문서 사이트를 생성합니다.

Backend 문서 변경이 반영되었는지만 검사할 때는 다음 명령을 사용합니다.

npm run docs:sync:check

문서 사이트 배포

Cloudflare Pages 직접 배포는 문서 동기화, 타입 검사와 빌드를 모두 수행합니다.

npm run docs:deploy

개발팀 접근 제어와 Pages 설정은 Cloudflare Access 운영 문서를 따릅니다.

문서 작성 위치

위치	용도
docs/*.mdx	주요 문서 페이지
docs/backend/*.md	../Backend/docs에서 생성한 Backend 문서
scripts/sync-backend-docs.mjs	Backend 문서 동기화 및 차이 검사
sidebars.ts	문서 사이드바 순서
docusaurus.config.ts	사이트 제목, 내비게이션, 플러그인 설정
src/pages/index.tsx	문서 홈 화면
src/css/custom.css	Docusaurus 전역 스타일