jekyll doc theme
1.0.0
자세한 정보와 데모를 보려면 웹사이트를 방문하세요.
시작하기 전에 Ruby와 gem이 필요합니다.
# install bundler
gem install bundler
# clone the project
git clone https://github.com/aksakalli/jekyll-doc-theme.git
cd jekyll-doc-theme
# install dependencies
bundle install
# run jekyll with dependencies
bundle exec jekyll serve
Github 페이지를 지원하기 위해 이동하면서 많은 파일이 /asset
폴더로 재배치되었습니다.
또는 프로덕션 성능 향상을 위해 Nginx에서 파일을 제공하는 다단계 Dockerfile을 사용하여 배포할 수 있습니다.
사이트의 JEKYLL_BASEURL
에 대한 이미지를 빌드합니다.
docker build --build-arg JEKYLL_BASEURL="/your-base/url" -t jekyll-doc-theme .
(또는 루트의 경우 비워 두십시오: JEKYLL_BASEURL=""
) 제공하십시오.
docker run -p 8080:80 jekyll-doc-theme
원격 테마 플러그인을 사용하여 Github 페이지에서도 테마를 사용할 수 있습니다.
Gemfile
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", group: :jekyll_plugins
_config.yml
# Configure the remote_theme plugin with the gh-pages branch
# or the specific tag
remote_theme: aksakalli/jekyll-doc-theme@gh-pages
프로젝트의 파일은 동일한 이름을 가진 테마 파일을 재정의합니다. 예를 들어, 이에 대한 가장 많은 댓글 사용 사례는 사이트 테마나 색상을 수정하는 것입니다. 이렇게 하려면 다음 단계를 수행해야 합니다.
aksakalli/jekyll-doc-theme/asset/css/main.scss
의 내용을 자신의 프로젝트에 복사합니다(폴더 구조 유지). // Bootstrap variable overrides
$grid-gutter-width: 30px !default;
$container-desktop: (900px + $grid-gutter-width) !default;
$container-large-desktop: (900px + $grid-gutter-width) !default;
@import // Original import statement
{% if site.bootwatch %}
"bootswatch/{{site.bootwatch | downcase}}/variables",
{% endif %}
"bootstrap",
{% if site.bootwatch %}
"bootswatch/{{site.bootwatch | downcase}}/bootswatch",
{% endif %}
"syntax-highlighting",
"typeahead",
"jekyll-doc-theme"
;
// More custom overrides.
MIT 라이선스로 출시되었습니다.