Скачать jekyll doc theme - jekyll doc theme скачать исходный код

jekyll doc theme

Другие категории

1.0.0

Скачать

Тема Джекилла Дока

Перейдите на сайт для получения подробной информации и демонстрации.

Запуск локально

Перед началом вам понадобятся Ruby и драгоценные камни, затем:

 # 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 .

CSS/
шрифты/
изображение/
js/
404.html
allposts.html
search.json

Докер

Альтернативно вы можете развернуть его с помощью многоэтапного Dockerfile, который обслуживает файлы из Nginx для повышения производительности в рабочей среде.

Создайте изображение для JEKYLL_BASEURL вашего сайта:

 docker build --build-arg JEKYLL_BASEURL="/your-base/url" -t jekyll-doc-theme .

(или оставьте его пустым для root: JEKYLL_BASEURL="" ) и обслуживайте его:

 docker run -p 8080:80 jekyll-doc-theme

Страницы Гитхаба

Тема также доступна на страницах Github с помощью плагина Remote Theme:

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.