문서 기여하기
문서 기여하기 (Contributing to Documentation)
LiteLLM 공식 문서는 Docusaurus 3 기반으로 만들어져요. 문서 저장소를 클론하고 로컬에서 실행해 보면서, 수정 사항을 검증한 뒤 PR을 열면 된답니다.
출처: 문서
본문
이 사이트는 모던한 정적 사이트 생성기인 Docusaurus 3 로 만들어졌습니다.
문서 저장소를 클론하세요:
git clone https://github.com/BerriAI/litellm-docs.git
cd litellm-docs
로컬에서 문서를 실행하기 위한 셋업 (Local setup)
의존성을 설치합니다:
npm install
문서 사이트를 로컬에서 실행합니다:
npm start
문서는 여기에서 열어볼 수 있어요: http://localhost:3000/ .
문서 변경하기 (Making changes to Docs)
- 모든 문서는
docs디렉터리 아래에 있어요. - 블로그 글은
blog디렉터리 아래에 있어요. - 새로운
.md파일을 추가하거나 계층 구조를 편집할 때는,sidebars.js도 업데이트해야 하는지 확인하세요.
변경 사항 검증하기 (Verify your changes)
PR을 열기 전에 다음을 실행하세요:
npm run build
변경 사항을 테스트한 뒤, github.com/BerriAI/litellm-docs 에 풀 리퀘스트를 열면 됩니다.