huggingface/hub-docs

해결하는 문제

이 저장소는 Hugging Face Hub 웹사이트에 표시되는 문서의 공식 소스입니다. 웹사이트 콘텐츠(Markdown으로 작성)를 게시 전에 구조화된 방식으로 저장, 편집, 검토해야 하는 필요성을 해결합니다.

작동 방식

사이트는 docs 폴더에서 문서 콘텐츠를 가져옵니다. 이 폴더에는 Markdown 파일이 가득합니다. 변경하려면 이 파일을 편집하고, 변경 사항을 커밋하고, 풀 리퀘스트를 열기만 하면 됩니다. 그러면 자동화된 봇이 미리보기 페이지를 구축하여 병합 전에 편집 내용을 확인할 수 있는 직접 URL을 제공합니다. 빠른 편집의 경우 로컬 개발 환경을 설정할 필요가 없습니다. 로컬에서 테스트하려면 hf-doc-builder 패키지를 설치하고 doc-builder preview 명령을 사용하여 자신의 머신에서 사이트를 렌더링할 수 있습니다.

대상 사용자

Hugging Face Hub 문서를 읽거나 기여하는 모든 사람을 위한 것입니다. 여기에는 Hub를 사용하는 개발자, 문서를 개선하려는 커뮤니티 구성원, 콘텐츠 정확성을 유지하는 기술 문서 작성자가 포함됩니다.

주요 특징

• 간단한 기여는 거의 설정이 필요 없습니다: Markdown 파일을 편집하고 풀 리퀘스트를 열기만 하면 됩니다.
• 자동화된 봇이 모든 풀 리퀘스트에 대해 미리보기 URL을 구축하므로 사이트가 어떻게 보일지 정확히 확인할 수 있습니다.
• 기본 편집에는 로컬 환경이 필요 없어 기여 장벽이 낮아집니다.
• 더 깊은 작업을 위해 공식 doc-builder 도구가 로컬 미리보기 명령을 제공합니다.
• 이 저장소는 대화형 Hub 유틸리티, 추론 및 작업을 위한 관련 도구에 연결되는 동반 huggingface.js 패키지를 참조합니다.