gitbook
1.0.0
문서 - 커뮤니티 - 개발자 문서 - 변경 - 버그 보고서
팀을위한 기술 지식을 관리하기위한 플랫폼 인 Gitbook에 오신 것을 환영합니다.
이 저장소에는 Gitbook의 게시 된 컨텐츠를 렌더링하는 데 사용되는 오픈 소스 코드가 포함되어 있습니다.
시작하기
기여
기여의 유형
라이센스
감사의 말
레거시 gitbook
이 프로젝트의 로컬 버전을 실행하려면 다음을 수행하십시오.
node.js (버전 :> = 18.x)
혈액 요소 질소
REPO를 공개 Github 리포지토리로 클론하십시오. 코드를 배포하려는 경우 소스 코드를 공개하여 GNU GPLV3을 준수하십시오. 개인 저장소에서 복제하려면 상업용 라이센스를 얻습니다.
git clone https://github.com/gitbookIO/gitbook.git
프로젝트 버전의 node 사용하고 있는지 확인하십시오. nvm use 실행하면 로컬 버전이 올바른 버전으로 변경됩니다.
BUN을 통해 프로젝트의 종속성을 설치하십시오.
bun install
로컬 개발 서버를 시작하십시오.
bun dev
웹 브라우저에서 게시 된 gitbook 공간을 열고 http://localhost:3000/ 로 접두사합니다.
예 :
http : // localhost : 3000/docs.gitbook.com
http : // localhost : 3000/open-source.gitbook.io/midjourney
게시 된 GitBook 사이트는 로컬 개발 인스턴스를 통해 액세스 할 수 있으며 코드베이스에 대한 업데이트는 브라우저에 반영됩니다.
bun format : 코드 형식
bun lint : 코드를 보려고합니다
모든 풀 반복은 회귀를 방지하기 위해 시각 및 성능 테스트에 대해 테스트됩니다.
Gitbook의 렌더링 엔진은 완전히 오픈 소스이며 Next.js 위에 제작되었습니다. 기고 가이드로 가서 첫 번째 풀 요청 추가에 대한 워크 플로에 대해 자세히 알아보십시오.
기술 지식을 문서화하기위한 최상의 도구를 구축 할 수 있도록 Gitbook에 기여하는 것이 좋습니다. 기여할 수있는 몇 가지 빠른 방법을 찾고 있다면 인기있는 기부금에 대해 자세히 알아 보려면 계속 읽으십시오.
Gitbook UI는 packages/gitbook/src/intl/translations 에있는 일련의 번역 파일을 사용하여 렌더링됩니다. 우리는 UI에 대한 모든 추가 번역을 환영합니다.
버그가 발생하거나 해결하고 싶은 문제를 찾으십니까? Gitbook과 관련된 문제를 해결하도록 도와 주면 모든 사람의 경험이 크게 향상됩니다. 이 저장소의 문제 섹션으로 이동하여 이미 도울 수있는 버그 유형에 대해 자세히 알아보십시오.
경고
이 프로젝트를 자체 주최 할 수는 있지만이 옵션이 귀하의 필요에 맞는 확실하지 않으면 권장하지 않습니다.
Gitbook에 특정 기능을 추가하려고하십니까? 기고 가이드로 가서 시작하십시오.
이 프로젝트를 자체 주최하면 향후 업데이트를 유지 하고 병합하는 책임이 있습니다. 우리는이 프로젝트의 포크 및 자체 호스트 사례에 대한 지원, 유지 보수 또는 업데이트를 보장 할 수 없습니다.
우리는 커뮤니티가 Gitbook의 미래를 협력하고 밀어 붙일 수 있도록 최대한 쉽게 만들고자합니다. 따라서 자신만의 버전을 만드는 대신 제품에 직접 기여하는 것이 좋습니다.
이 프로젝트를 사용하면 GitBook 게시 된 콘텐츠의 렌더링 부분을 자조적으로 주최 할 수 있습니다. 자조 주최에는 장단점이 있습니다.
프로 측면에서는 콘텐츠의 모양과 느낌을 사용자 정의하고 응용 프로그램에 문서를 더 잘 포함시킬 수 있습니다.
CON 측면에서는 게시 된 사이트의 신뢰성에 대한 책임을지고 GitBook 플랫폼의 변경 사항으로 렌더러를 최신 상태로 유지합니다.
GNU GPLV3 라이센스에 따라 배포됩니다.
코드를 배포하려는 경우 GNU GPLV3을 준수하도록 소스 코드를 공개해야합니다. 개인 저장소에서 복제하려면 상업용 라이센스를 얻습니다.
자세한 내용은 LICENSE 참조하십시오.
[!
<a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?message=documented%20on%20gitbook&logo=gitbook&logocolor=ffffff&label=%20&labelcolor=5c5c5c5c5ccolor=3f89a "
/> </a>이러한 프로젝트 없이는 GitBook이 불가능합니다.
다음 .js
혈액 요소 질소
테일 윈드 CSS
프레이머 모션
Gitbook의 이전 버전과 CLI 도구는 이제 더 이상 사용되지 않습니다. 기존 저장소를 여전히 볼 수 있으며이 지점에서 커밋됩니다.
