just the docs
v0.10.0
내장된 검색 기능을 갖춘 문서용 현대적이고 사용자 정의가 가능하며 반응성이 뛰어난 Jekyll 테마입니다.
종속성이 거의 없이 GitHub 페이지에서 쉽게 호스팅됩니다.
실제로 확인해 보세요!
다양한 Just the Docs 기능을 안내하는 동영상
Just the Docs 템플릿은 Just the Docs 테마를 사용하는 새 웹사이트를 만드는 가장 간단하고 빠르며 쉬운 방법을 제공합니다. 사이트 생성을 시작하려면 "템플릿 사용"을 클릭하세요!
참고: 테마를 사용하기 위해 Just the Docs 저장소를 복제하거나 분기할 필요가 없습니다 ! 테마 문서를 로컬에서 탐색하거나, 테마 개발에 기여하거나, Just the Docs를 기반으로 새 테마를 개발하려는 경우에만 그렇게 해야 합니다.
템플릿으로 생성된 사이트를 GitHub 페이지에 게시하도록 쉽게 설정할 수 있습니다. 템플릿 README 파일에는 기타 세부 정보와 함께 해당 작업을 수행하는 방법이 설명되어 있습니다.
Jekyll이 컴퓨터에 설치되어 있으면 생성된 사이트를 로컬에서 빌드하고 미리 볼 수도 있습니다. 이를 통해 변경 사항을 커밋하기 전에 테스트하고 GitHub 페이지를 기다리지 않아도 됩니다. 1 그리고 GitHub 페이지가 아닌 다른 플랫폼에 로컬 빌드를 배포할 수 있습니다.
보다 구체적으로 생성된 사이트는 다음과 같습니다.
Gemfile 을 사용하고 just-the-docs gem을 로드합니다. 그 외에도 템플릿을 사용하여 만든 사이트를 원하는 대로 자유롭게 맞춤 설정할 수 있습니다. 사용하는 just-the-docs 와 Jekyll의 버전을 쉽게 변경할 수 있을 뿐만 아니라 추가 플러그인을 추가할 수도 있습니다.
또는 새 사이트를 만들지 않고도 테마를 Ruby Gem으로 설치할 수 있습니다.
Jekyll 사이트의 Gemfile 에 다음 줄을 추가하세요:
gem "just-the-docs" 그리고 Jekyll 사이트의 _config.yml 에 다음 줄을 추가하세요:
theme : just-the-docs그런 다음 다음을 실행합니다.
$ bundle
또는 다음과 같이 직접 설치하십시오.
$ gem install just-the-docs
또는 사이트를 개발하는 동안 Docker 내에서 실행할 수 있습니다.
$ docker-compose up
사용법 정보는 설명서를 참조하세요.
버그 보고서, 새로운 기능 제안 및 끌어오기 요청은 GitHub(https://github.com/just-the-docs/just-the-docs)에서 환영합니다. 이 프로젝트는 협업을 위한 안전하고 환영받는 공간이 되도록 의도되었으며 기여자는 기여자 규약 행동 강령을 준수해야 합니다.
이 테마를 개발하기 위한 환경을 설정하려면 이 저장소를 포크하고 루트 디렉터리에서 bundle install 실행하세요.
VSCode에 대한 최신 devcontainer 구성이 포함되어 있습니다.
테마는 일반 Jekyll 사이트와 동일하게 설정되어 있습니다! 테마를 테스트하려면, bundle exec jekyll serve 실행하고 http://localhost:4000 에서 브라우저를 여세요. 그러면 테마를 사용하여 Jekyll 서버가 시작됩니다. 페이지, 문서, 데이터 등을 평소처럼 추가하여 테마 내용을 테스트하세요. 테마와 콘텐츠를 수정하면 사이트가 다시 생성되며 새로 고침 후에는 평소와 마찬가지로 브라우저에 변경 사항이 표시됩니다.
이 테마가 출시되면 Git으로 추적된 _layouts , _includes 및 _sass 파일만 gem에 포함됩니다.
테마는 MIT 라이센스 조건에 따라 오픈 소스로 제공됩니다.
변경 사항을 GitHub에 푸시한 후 사이트 변경 사항이 게시되는 데 최대 10분이 걸릴 수 있습니다. ↩
