문서 기여 가이드

온라인 편집

온라인에서 문서를 편집하려면 온라인 문서 왼쪽 아래의 이 페이지 온라인 편집을 클릭하세요. 브라우저가 저장소 안의 해당 파일 위치로 이동합니다. 오른쪽 위의 편집 버튼을 클릭해 수정한 뒤 미리보기로 결과를 확인하고, 문제가 없으면 변경 사항 제출을 클릭해 제출합니다.

제출 후에는 검토를 거치며, 통과되면 메인 저장소에 병합됩니다. 일반적으로 메인 저장소에 병합된 뒤 온라인 문서는 자동으로 업데이트됩니다. 업데이트되지 않는다면 페이지를 수동으로 새로고침하거나, 제출 후 몇 분 기다린 다음 다시 새로고침해 주세요.

로컬 편집

문서는 기능 브랜치를 만들 필요 없이 master 브랜치에 직접 PR 제출할 수 있습니다.

코드를 제출하기 전에 로컬에서 Git 전역 설정을 완료했는지 확인해 주세요.

git config --global user.name 당신의 Git 사용자 이름
git config --global user.email 커밋 이메일. 코드 플랫폼 계정 이메일과 반드시 일치해야 합니다

1. 프로젝트 Fork: 오른쪽 위의 Fork를 클릭해 자신의 저장소로 복사합니다
2. 저장소 클론: git clone
3. 문서 편집: docs 디렉터리에서 수정할 파일을 찾아 Markdown 문법으로 편집합니다(Markdown 문법 참고)
4. 변경 사항 커밋: git commit -m "문서 변경 설명"
5. 브랜치 푸시: git push origin master

제출 후 자신이 fork한 저장소 페이지에서 Pull Request 버튼을 클릭해 PR을 만듭니다.

Konado 문서 로컬 미리보기

Konado 문서는 VitePress 기반으로 구축됩니다. 문서 수정 내용이 예상대로 표시되는지 확인하기 위해, 코드를 제출하기 전에 로컬에서 미리보기로 검증하는 것을 권장합니다.

사전 준비: Node.js 설치

VitePress는 Node.js 환경에서 실행되므로, 요구 버전에 맞는 Node.js를 먼저 설치해야 합니다.

1. 버전 요구 사항: Node.js 18.x 이상을 권장합니다. 호환성을 고려하면 LTS 장기 지원 버전이 가장 좋습니다.
2. 다운로드 및 설치:
   • Node.js 공식 다운로드 주소에 접속합니다: https://nodejs.org/
   • 운영체제(Windows/macOS/Linux)에 맞는 설치 패키지를 선택하고 설치 마법사에 따라 완료합니다(Windows에서는 "Add to PATH" 옵션 선택을 권장합니다).
3. 설치 확인: 터미널(Windows는 명령 프롬프트/PowerShell, macOS/Linux는 터미널)을 열고 다음 명령으로 Node.js와 npm(Node.js에 포함된 패키지 관리자)이 정상 설치되었는지 확인합니다.

   # Node.js 버전 확인
   node -v
   # npm 버전 확인
   npm -v

   v20.10.0, 10.2.3처럼 명확한 버전 번호가 출력되면 설치가 성공한 것입니다.

선택 최적화: npm 의존성 다운로드 속도가 느리다면 중국 내 미러를 설정해 속도를 개선할 수 있습니다.

npm config set registry https://registry.npmmirror.com

프로젝트 의존성 설치

Konado 프로젝트의 루트 디렉터리로 이동한 뒤, 다음 명령을 실행해 문서 미리보기에 필요한 의존성을 설치합니다.

npm install

명령 실행이 완료되고 터미널에 오류가 없으면 의존성 설치가 성공한 것입니다.

로컬 미리보기 서비스 시작

의존성 설치가 끝나면 다음 명령으로 VitePress 개발 서버를 시작합니다.

npm run docs:dev

미리보기 문서 접속

명령이 성공적으로 실행되면 터미널에 다음과 비슷한 정보가 출력됩니다.

vitepress v1.6.4

➜  Local:   http://localhost:5173/konado/
➜  Network: use --host to expose
➜  press h to show help

브라우저를 열고 출력 정보의 Local 주소(기본값: http://localhost:5173/konado/)로 접속하면 로컬 문서를 볼 수 있습니다.

추가 설명

1. 실시간 새로고침: 문서를 수정한 뒤 서비스를 다시 시작할 필요가 없습니다. 브라우저가 자동으로 새로고침되어 수정된 결과를 실시간으로 보여 줍니다.
2. 포트 문제: localhost:5173 포트가 사용 중이면 VitePress가 5174 같은 사용 가능한 포트로 자동 전환합니다. 터미널에 실제 출력된 주소를 기준으로 접속해 주세요.
3. LAN 접속: 같은 LAN 안의 다른 장치(예: 휴대폰, 다른 컴퓨터)에서 문서를 미리보려면 npm run docs:dev -- --host 명령을 실행하세요. 터미널에 네트워크에서 접속 가능한 IP 주소가 출력됩니다.
4. 서버 중지: 터미널에서 Ctrl + C를 누르면 로컬 미리보기 서비스를 중지할 수 있습니다.