1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/chen_ke_715-chen_ke_715

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
Внести вклад в разработку кода
Синхронизировать код
Отмена
Подсказка: Поскольку Git не поддерживает пустые директории, создание директории приведёт к созданию пустого файла .keep.
Loading...
README.md

[Basically Basic Jekyll Theme]

LICENSE Jekyll Ruby gem Tip Me via PayPal

Basically Basic — это тема Jekyll, которая предназначена для замены стандартной темы Minima с некоторыми улучшениями:

  • Чистый адаптивный дизайн с шестью настраиваемыми скинами;
  • Макет Curriculum Vitæ/резюме на основе данных JSON;
  • Макет страницы «О нас»;
  • Поиск по всему сайту, предоставляемый Algolia или Lunr;
  • Поддержка Disqus Comments и Google Analytics;
  • SEO-рекомендации через Jekyll SEO Tag.

Если вам нравится эта тема, пожалуйста, рассмотрите возможность поддержки меня для разработки и обслуживания.

Support via PayPal

Basically Basic live preview

Содержание

  1. Установка
    1. Метод Ruby Gem
    2. Метод GitHub Pages
      1. Удалите ненужное
  2. Обновление
    1. Ruby Gem
    2. Удаленная тема
    3. Используйте Git
      1. Загрузите обновления
    4. Обновите файлы вручную
  3. Структура
    1. Начните с нуля
    2. Начните с jekyll new
  4. Конфигурация
    1. Скины
    2. Шрифты Google
    3. Текст
    4. Навигация
    5. Пагинация
    6. Поиск
      1. Lunr (по умолчанию)
      2. Algolia
    7. Автор
    8. Время чтения
    9. Комментарии (через Disqus)
    10. Google Analytics
    11. Авторские права
  5. Макеты
    1. layout: default
    2. layout: post
    3. layout: page
    4. layout: home
    5. layout: posts
    6. layout: categories
    7. layout: tags
    8. layout: collection
    9. layout: category
    10. layout: tag
    11. layout: about
    12. layout: cv
  6. Изображения
  7. Настройка
    1. Переопределение включений и макетов
    2. Настройка Sass (SCSS)
    3. Настройка JavaScript
    4. SVG-иконы
    5. Настройка содержимого боковой панели
  8. Разработка
  9. Вклад
  10. Кредиты
  11. Лицензия

Установка

Если вы используете Jekyll v3.5+ и самостоятельно размещаете сайт, вы можете быстро установить тему как Ruby gem. Если вы размещаете на GitHub Pages, вы можете установить её как удалённую тему или напрямую скопировать все файлы темы (см. структуру ниже) в свой проект.

Метод Ruby Gem

  1. Добавьте эту строку в Gemfile вашего сайта Jekyll:

    gem "jekyll-theme-basically-basic"
  2. Добавьте эту строку в файл _config.yml вашего сайта Jekyll: Тема: jekyll-theme-basically-basic

  3. Затем запустите Bundler, чтобы установить гем темы и зависимости:

bundle install

Метод GitHub Pages

GitHub Pages полностью поддерживает любую тему, размещённую на GitHub.

  1. Замените gem "jekyll" на:

    gem "github-pages", group: :jekyll_plugins
  2. Выполните bundle update и убедитесь, что все гемы установлены правильно.

  3. Добавьте remote_theme: "mmistakes/jekyll-theme-basically-basic" в файл _config.yml. Удалите любые другие записи theme: или remote_theme:.


Примечание: Ваш сайт Jekyll должен быть доступен сразу по адресу http://USERNAME.github.io. Если это не так, вы можете принудительно выполнить перестройку, настроив свой сайт (см. ниже для получения более подробной информации).

Если вы размещаете несколько сайтов на основе Jekyll под одной учётной записью GitHub, вам придётся использовать Project Pages вместо User Pages. По сути, вы переименовываете репозиторий во что-то отличное от USERNAME.github.io и создаёте ветку gh-pages из master. Для получения дополнительной информации о том, как настроить всё это, обратитесь к документации GitHub.

Удалить ненужное

Если вы разветвили или загрузили репозиторий jekyll-theme-basically-basic, вы можете безопасно удалить следующие файлы и папки:

  • .editorconfig;
  • .gitattributes;
  • .github;
  • .scss-lint.yml;
  • CHANGELOG.md;
  • jekyll-theme-basically-basic.gemspec;
  • LICENSE;
  • Rakefile;
  • README.md;
  • screenshot.png;
  • /docs;
  • /example.

Обновление

Если вы используете версию Ruby Gem или удалённую версию Basically Basic, обновление происходит довольно безболезненно.

Чтобы проверить, какую версию вы сейчас используете, просмотрите исходный код вашего созданного сайта, и вы должны увидеть что-то похожее на:

<!--
    Basically Basic Jekyll Theme 1.4.4
    Copyright 2017-2018 Michael Rose - mademistakes.com | @mmistakes
    Free for personal and commercial use under the MIT license
    https://github.com/mmistakes/jekyll-basically-theme/blob/master/LICENSE
-->

В верхней части каждого файла .html, /assets/css/main.css и /assets/js/main.js.

Ruby Gem

Просто выполните bundle update, если вы используете Bundler (у вас есть Gemfile), или gem update jekyll-theme-basically-basic, если нет.

Удаленная тема

При размещении с помощью GitHub Pages вам нужно будет отправить коммит, чтобы принудительно перестроить его с последним релизом темы.

Пустой коммит тоже подойдёт, если у вас сейчас нечего отправлять:

git commit --allow-empty -m "Force rebuild of site"

Используйте Git

Если вы хотите получить максимальную отдачу от рабочего процесса Jekyll + GitHub Pages, то вам необходимо использовать Git. Чтобы загрузить обновления тем, сначала убедитесь, что есть вышестоящий удалённый доступ. Если вы разветвили репозиторий темы, то, скорее всего, всё в порядке.

Для двойной проверки выполните git remote -v и убедитесь, что вы можете получить данные из origin https://github.com/mmistakes/jekyll-theme-basically-basic.git.

Чтобы добавить его, вы можете сделать следующее:

git remote add upstream https://github.com/mmistakes/jekyll-theme-basically-basic.git

Загрузите обновления

Теперь вы можете получать любые коммиты, сделанные в ветке master темы, с помощью:

git pull upstream master

В зависимости от количества настроек, которые вы внесли после разветвления, вероятно, возникнут конфликты слияния. Проработайте любые конфликтующие файлы, отметьте изменения, которые хотите сохранить, а затем зафиксируйте их.

Обновите файлы вручную

Другой способ справиться с обновлениями — загрузить тему и заменить ваши макеты, включения и ресурсы на новые вручную. Чтобы убедиться, что вы не пропустите никаких изменений, вероятно, стоит просмотреть журнал коммитов темы, чтобы узнать, что изменилось с тех пор. Чек-лист важных папок и файлов, о которых следует помнить:

Название Описание
_layouts Заменить всё. Примените изменения, если вы настроили какие-либо макеты.
_includes Заменить всё. Примените изменения, если вы настроили какие-либо включения.
assets Заменить всё. Примените изменения, если вы настраивали таблицы стилей или скрипты.
_sass Заменить всё. Примените изменения, если вы настраивали партиалы Sass.
_data/theme.yml Безопасно хранить. Убедитесь, что не было серьёзных структурных изменений или дополнений.
_config.yml Безопасно хранить. Убедитесь, что не было серьёзных структурных изменений или дополнений.

Примечание: Если вы не видите последнюю версию, обязательно очистите кэш браузера и CDN. В зависимости от вашей среды хостинга могут быть кэшированы более старые версии /assets/css/main.css, /assets/js/main.js или *.html.

Структура

Макеты, включения, партиалы Sass и файлы данных размещаются в своих стандартных расположениях. Таблицы стилей и скрипты находятся в папке assets, а несколько файлов для разработки — в корневом каталоге проекта.

Обратите внимание: если вы установили Basically Basic с помощью метода Ruby Gem, файлы темы в _layouts, _includes, _sass и /assets будут отсутствовать. Это нормально, поскольку они связаны с гемом jekyll-theme-basically-basic.

jekyll-theme-basically-basic
├── _data                      # data files
|  └── theme.yml               # theme settings and custom text
├── _includes                  # theme includes and SVG icons
├── _layouts                   # theme layouts (see below for details)
├── _sass                      # Sass partials
├── assets
|  ├── javascripts
|  |  └── main.js
|  └── stylesheets
|     └── main.scss
├── _config.yml                # sample configuration
└── index.md                   # sample home page (all posts/not paginated)

Начало работы

После создания Gemfile и установки темы вам нужно будет добавить и отредактировать следующие файлы:

  • _config.yml
  • /_data/theme.yml
  • index.md

Примечание: обратитесь к документации по пагинации ниже, чтобы узнать, как включить её для домашней страницы.

Запуск с jekyll new

Команда jekyll new поможет вам быстрее всего приступить к работе.

Отредактируйте _config.yml и создайте _data/theme.yml, как указано выше, и всё готово.

Конфигурация

Настройка элементов сайта (lang, title, description, logo, author и т. д.) происходит в вашем проекте _config.yml. См. пример конфигурации в этом репозитории для дополнительной справки.

Описание
lang Используется для указания языка текста (например, en-US, en-GB, fr)
title Заголовок вашего сайта (например, Dungan's Awesome Site)
description Краткое описание сайта (например, блог о кузнечиках)
url Полный URL вашего сайта (например, https://groverloaf.org)
author Глобальная информация об авторе (см. ниже)
logo Путь к общему логотипу сайта ~100x100px (например, /assets/your-company-logo.png)
twitter_username Имя пользователя в Twitter для всего сайта, используется как ссылка в боковой панели
github_username Имя пользователя на GitHub для всего сайта, используется как ссылка в боковой панели

Для получения дополнительных параметров конфигурации обязательно ознакомьтесь с документацией по: jekyll-seo-tag, jekyll-feed, jekyll-paginate и jekyll-sitemap. Скин

Эта тема доступна в шести различных скинах (цветовых вариациях). Чтобы изменить скин, добавьте один из следующих элементов в файл /_data/theme.yml:

skin: default skin: night skin: plum
default-skin night-skin plum-skin
skin: sea skin: soft skin: steel
sea-skin soft-skin steel-skin

Шрифты Google

В этой теме можно легко использовать шрифты Google Fonts на протяжении всей темы. Просто добавьте следующее в ваш файл [/_data/theme.yml], заменив шрифт name и weights соответственно.

google_fonts:
  - name: "Fira Sans"
    weights: "400,400i,600,600i"
  - name: "Fira Sans Condensed"

Текст

Чтобы изменить текст, найденный на протяжении всей темы, добавьте следующее в файл [/_data/theme.yml] и настройте по мере необходимости.

t:
  skip_links: "Пропустить ссылки"
  skip_primary_nav: "Перейти к основной навигации"
  skip_content: "Перейти к содержимому"
  skip_footer: "Перейти к нижнему колонтитулу"
  menu: "Меню"
  search: "Поиск"
  site_search: "Сайт поиска"
  results_found: "Результат(ы) найден"
  search_placeholder_text: "Введите поисковый запрос..."
  home: "Главная"
  newer: "Новее"
  older: "Старее"
  email: "Электронная почта"
  subscribe: "Подписаться"
  read_more: "Читать далее"
  posts: "Сообщения"
  page: "Страница"
  of: "из"
  min_read: "мин чтения"
  present: "Настоящее время"

Навигация

По умолчанию все внутренние страницы с заголовком будут добавлены в меню «вне холста». Для более детального управления и сортировки этих ссылок меню:

  1. Создайте собственный список, чтобы переопределить настройки по умолчанию, добавив массив navigation_pages в файл [/_data/theme.yml].

  2. Добавьте необработанные пути страниц в том порядке, в котором вы хотите:

    navigation_pages:
      - about.md
      - cv.md

Заголовок каждой ссылки меню и URL будут заполнены на основе их title и permalink соответственно.

Разбиение на страницы

Разбейте основной список сообщений на более мелкие списки и отобразите их на нескольких страницах, включив разбиение на страницы.

  1. Включите плагин jekyll-paginate в свой Gemfile.

    group :jekyll_plugins do
      gem "jekyll-paginate"
    end
  2. Добавьте jekyll-paginate к массиву gems в вашем файле _config.yml и следующие настройки разбиения на страницы:

    paginate: 5  # количество сообщений для отображения на странице
    paginate_path: /page:num/
  3. Создайте index.html (или переименуйте index.md) в корне вашего проекта и добавьте следующую переднюю часть:

    layout: home
    paginate: true

Поиск

Для включения поиска по всему сайту добавьте search: true в ваш _config.yml.

Lunr (по умолчанию)

Поиск по умолчанию использует Lunr для создания поискового индекса всех ваших документов. Этот метод на 100% совместим с сайтами, размещёнными на GitHub Pages.

Примечание: только первые 50 слов тела сообщения или страницы добавляются в поисковый индекс Lunr. Установка search_full_content на true в вашем _config.yml переопределит это и может повлиять на производительность загрузки страницы. Использование Jekyll с Algolia

  1. Добавьте гем jekyll-algolia в свой Gemfile в раздел :jekyll_plugins.

    group :jekyll_plugins do
      gem "jekyll-feed"
      gem "jekyll-seo-tag"
      gem "jekyll-sitemap"
      gem "jekyll-paginate"
      gem "jekyll-algolia"
    end
  2. После этого загрузите все зависимости, выполнив команду bundle install.

  3. В файле _config.yml переключитесь на поисковый провайдер algolia:

    search_provider: algolia
  4. Добавьте учётные данные Algolia в файл _config.yml. Если у вас нет аккаунта Algolia, вы можете открыть бесплатный план Community. После регистрации вы сможете получить свои учётные данные на панели управления.

    algolia:
      application_id: # YOUR_APPLICATION_ID
      index_name: # YOUR_INDEX_NAME
      search_only_api_key: # YOUR_SEARCH_ONLY_API_KEY
      powered_by: # true (default), false
  5. После настройки учётных данных вы можете запустить индексацию с помощью следующей команды:

    Для пользователей Windows:

    set ALGOLIA_API_KEY=your_admin_api_key
    bundle exec jekyll algolia

    Обратите внимание, что для переменной ALGOLIA_API_KEY необходимо установить ключ администратора.

  6. Для использования поиска Algolia с сайтами GitHub Pages следуйте этому руководству по развёртыванию. Или этому руководству по развёртыванию на Netlify.

Примечание: плагин Jekyll Algolia можно настроить несколькими способами. Обязательно ознакомьтесь с полной документацией, чтобы узнать, как исключить файлы и другие важные настройки.

Автор

Информация об авторе используется в качестве метаданных для строк «от» и распространяет поле creator сводных карточек Twitter со следующим передним вопросом в _config.yml:

author:
  name: John Doe
  twitter: johndoetwitter
  picture: /assets/images/johndoe.png

Общую информацию об авторе можно переопределить в документе таким же образом:

author:
  name: Jane Doe
  twitter: janedoetwitter
  picture: /assets/images/janedoe.png

Или указав соответствующий ключ в переднем вопросе документа, который существует в site.data.authors. Например, у вас есть следующее в переднем вопросе документа:

author: megaman

И у вас есть следующее в _data/authors.yml:

megaman:
  name: Mega Man
  twitter: megamantwitter
  picture: /assets/images/megaman.png

drlight:
  name: Dr. Light
  twitter: drlighttwitter
  picture: /assets/images/drlight.png

В настоящее время author.picture используется только в layout: about. Рекомендуемый размер — 300 x 300 пикселей.

Время чтения

Чтобы включить счётчик времени чтения, добавьте read_time: true к YAML Front Matter поста или страницы.

Комментарии (через Disqus)

При желании, если у вас есть аккаунт Disqus, вы можете отобразить раздел комментариев под каждым постом.

Чтобы активировать комментарии Disqus, добавьте свой короткий URL Disqus в файл проекта _config.yml:

disqus:
shortname: my_disqus_shortname

Комментарии включены по умолчанию и будут отображаться только в рабочей среде при сборке с использованием следующего значения среды: JEKYLL_ENV=production.

Если вы не хотите отображать комментарии для определённого поста, вы можете отключить их, добавив comments: false к переднему вопросу этого поста.

Google Analytics

Чтобы включить Google Analytics, добавьте свой идентификатор отслеживания в _config.yml, например:

google_analytics: UA-NNNNNNNN-N

Подобно комментариям, скрипт отслеживания Google Analytics будет отображаться только в производственной среде. Производство при использовании следующего значения среды: JEKYLL_ENV=production.

Copyright

По умолчанию строка авторских прав в нижнем колонтитуле отображает текущий год (во время сборки), за которым следует название вашего сайта. Например, © 2018 Basically Basic.

Если вы хотите изменить это, добавьте copyright в свой файл _config.yml с соответствующим текстом:

copyright: "My custom copyright."

Макеты

Эта тема предоставляет следующие макеты, которые можно использовать, задав layout Front Matter на каждой странице, например так:

---
layout: name
---

layout: default

Этот макет обрабатывает всю базовую структуру страницы, размещая содержимое страницы между элементами верхнего и нижнего колонтитулов. Все остальные макеты наследуют этот и предоставляют дополнительные стили и функции внутри блока {{ content }}.

layout: post

Этот макет учитывает следующую переднюю часть:

# необязательный альтернативный заголовок для замены page.title в верхней части страницы
alt_title: «Basically Basic»

# необязательный подзаголовок под заголовком страницы
sub_title: «Название говорит само за себя»

# необязательный вводный текст под заголовками, разрешён Markdown
introduction: |
    Basically Basic — это тема Jekyll, предназначенная для замены стандартной --- [Minima](https://github.com/jekyll/minima). Соглашения и функции, найденные в Minima, полностью поддерживаются **Basically Basic**.

# дополнительные ссылки для действий
actions:
  - label: «Узнать больше»
    icon: github  # ссылается на имя значка SVG, см. полный список ниже
    url: «http://url-goes-here.com»
  - label: «Скачать»
    icon: download  # ссылается на имя значка SVG, см. полный список ниже
    url: «http://url-goes-here.com»

image:  # URL к героическому изображению, связанному с постом (например, /assets/page-pic.jpg)

# данные автора поста, если они отличаются от установленных в _config.yml
author:
  name: John Doe
  twitter: johndoetwitter

comments: false  # отключить комментарии к этому посту

Примечание: Героические изображения можно наложить прозрачным «акцентным» цветом, чтобы объединить их с палитрой темы. Чтобы включить, настройте CSS с помощью следующей переопределённой переменной Sass:

$intro-image-color-overlay: true;

layout: page

Визуально этот макет выглядит и действует так же, как layout: post, с двумя незначительными отличиями.

  • Авторская «строка» и дата публикации опущены.
  • Комментарии Disqus опущены.

layout: home

Этот макет учитывает ту же переднюю часть, что и layout: page, с добавлением следующего:

paginate: true  # включает цикл разбивки на страницы, см. раздел выше для дополнительной настройки
entries_layout: # list (по умолчанию), grid

По умолчанию посты отображаются в виде списка. Чтобы перейти к просмотру сетки, добавьте entries_layout: grid к передней части страницы.

layout: posts

Этот макет отображает все посты, сгруппированные по году публикации. Он учитывает ту же переднюю часть, что и layout: page.

По умолчанию посты отображаются в виде списка. Чтобы перейти к просмотру сетки, добавьте entries_layout: grid к передней части страницы.

layout: categories

Этот макет отображает все посты, сгруппированные по категориям. Он учитывает ту же переднюю часть, что и layout: page.

По умолчанию посты отображаются в виде списка. Чтобы перейти к просмотру сетки, добавьте entries_layout: grid к передней части страницы.

layout: tags

Этот макет отображает все посты, сгруппированные тегами. Он учитывает ту же переднюю часть, что и layout: page.

По умолчанию посты отображаются в виде списка. Чтобы перейти к просмотру сетки, добавьте entries_layout: grid к передней части страницы.

layout: collection

Этот макет отображает все документы, сгруппированные определённой коллекцией. Он учитывает ту же переднюю часть, что и layout: page, с дополнением:

collection: # название коллекции
entries_layout: # список (по умолчанию), сетка
show_excerpts: # истина (по умолчанию), ложь
sort_by: # дата (по умолчанию) заголовок
sort_order: # вперёд (по умолчанию), назад

Чтобы создать страницу, показывающую все документы в коллекции recipes, вы должны создать recipes.md в корне вашего... Проект и добавьте этот раздел:

title: Recipes
layout: collection
permalink: /recipes/
collection: recipes

По умолчанию документы отображаются в виде списка. Чтобы изменить на вид сетки, добавьте entries_layout: grid в раздел front matter страницы. Если вы хотите отсортировать коллекцию по заголовку, добавьте sort_by: title. Если вы хотите изменить порядок сортировки на обратный, добавьте sort_order: reverse.

layout: category

Этот макет отображает все сообщения, сгруппированные по определённой категории. Он использует тот же раздел front matter, что и layout: page, с добавлением следующего:

taxonomy: # название категории
entries_layout: # список (по умолчанию), сетка

Сообщения по умолчанию отображаются в виде списка. Для изменения на вид сетки добавьте entries_layout: grid в раздел front matter.

Чтобы создать страницу, показывающую все сообщения, назначенные категории foo, создайте файл foo.md в корне вашего проекта и добавьте следующий раздел front matter:

title: Foo
layout: category
permalink: /categories/foo/
taxonomy: foo

layout: tag

Этот макет отображает все сообщения, сгруппированные по определённому тегу. Он использует тот же раздел front matter, что и layout: page, с добавлением следующего:

taxonomy: # имя тега
entries_layout: # список (по умолчанию), сетка

Сообщения по умолчанию отображаются в виде списка. Для изменения на вид сетки добавьте entries_layout: grid в раздел front matter.

Чтобы создать страницу, показывающую все сообщения, назначенные тегу foo bar, создайте файл foo-bar.md в корне вашего проекта и добавьте следующий раздел front matter:

title: Foo Bar
layout: tag
permalink: /tags/foo-bar/
taxonomy: foo bar

layout: about

Этот макет использует тот же раздел front matter, что и layout: page, с дополнением для отображения изображения автора:

author:
  name: John Doe
  picture: /assets/images/johndoe.png

Рекомендуемый размер изображения составляет примерно 300 x 300 пикселей. Если объект author явно не установлен в разделе front matter о странице, тема будет использовать значение, установленное в _config.yml.

Если поле пусто, изображение не появится.

layout: cv

Этот макет использует тот же раздел front matter, что и layout: page. Он использует основанный на JSON стандарт файлов для данных резюме, чтобы удобно отображать curriculum vitæ или резюме без проблем.

Просто используйте конструктор резюме в браузере JSON Resume для экспорта файла JSON и сохраните его в своём проекте как _data/cv.json.

Изображения

Рекомендуемые размеры изображений в пикселях следующие:

Изображение Описание Размер
page.image.path Большое полностраничное изображение документа. Высокие изображения будут сдвигать контент вниз по странице. 1600 x 600 — хороший средний размер, к которому стоит стремиться.
page.image Сокращение для page.image.path, когда используется отдельно (без thumbnail, caption или других переменных). То же, что page.image.path
page.image.thumbnail Маленькое изображение документа, используемое в виде сетки. 400 x 200
author.picture Изображение страницы автора. 300 x 300

Настройка

Структура по умолчанию, стиль и скрипты этой темы могут быть переопределены и настроены двумя способами.

Переопределение включений и макетов

Значения по умолчанию темы можно переопределить, поместив файл с тем же именем в каталоги _includes или _layouts вашего проекта. Например:

  • Чтобы указать собственный путь стиля или метаданные для файла _includes/head.html, создайте каталог _includes в вашем проекте, скопируйте файл _includes/head.html из папки gem-версии Basically Basic в <your_project>/_includes и начните редактировать этот файл.

ProTip: чтобы найти файлы темы на вашем компьютере, запустите bundle show jekyll-theme-basically-basic. Это вернёт местоположение файлов темы gem.

Настройка Sass (SCSS)

Для переопределения стандартного Sass (расположенного в каталоге _sass темы), выполните одно из следующих действий:

  1. Скопируйте непосредственно из gem Basically Basic

    • Перейдите в локальную установку Basically Basic gem. Текст запроса:

directory (run bundle show jekyll-theme-basically-basic to get the path to it).
— Скопируйте содержимое /assets/stylesheets/main.scss оттуда в <your_project>.
— Настройте то, что вы хотите внутри <your_project>/assets/stylesheets/main.scss.

  1. Скопируйте из этого репозитория:
    — скопируйте содержимое assets/stylesheets/main.scss в <your_project>;
    — настройте то, что хотите внутри <your_project/assets/stylesheets/main.scss>.

Примечание: чтобы внести более обширные изменения и настроить частичные файлы Sass, упакованные в гем, вам потребуется скопировать полное содержимое каталога _sass в <your_project>, поскольку Jekyll в настоящее время считывает эти файлы именно таким образом.

Чтобы внести базовые изменения в стиль темы, переменные Sass можно переопределить, добавив их в <your_project>/assets/stylesheets/main.scss. Например, чтобы изменить цвет акцента, используемый во всей теме, добавьте следующее:

$accent-color: red;

Настройка JavaScript

Чтобы переопределить стандартный JavaScript, включенный в тему, выполните одно из следующих действий:

  1. Скопируйте непосредственно из локального каталога установки Basically Basic gem (запустите bundle show jekyll-theme-basically-basic, чтобы получить путь к нему):
    — скопируйте содержимое /assets/javascripts/main.js оттуда в <your_project>;
    — настройте то, что вы хотите внутри <your_project>/assets/javascripts/main.js.

  2. Скопируйте из этого репо:
    — скопируйте содержимое assets/javascripts/main.js в <your_project>;
    — настройте то, что вы хотите внутри <your_project>/assets/javascripts/main.js.

SVG-иконки

Тема использует логотипы социальных сетей и другую иконографию, сохранённую в формате SVG для обеспечения производительности и гибкости. Эти SVG находятся в каталоге _includes и имеют префикс icon-. Каждый значок имеет размер 16 x 16 и оптимизирован с помощью SVGO.

Иконка Имя файла
icon-arrow-left.svg
icon-arrow-right.svg
icon-bitbucket.svg
icon-calendar.svg
icon-codepen.svg
icon-download.svg
icon-dribbble.svg
icon-email.svg
icon-facebook.svg
icon-flickr.svg
icon-github.svg
icon-gitlab.svg
icon-googleplus.svg
----------------- ---------------------------------------------------------------
username Имя пользователя в данной социальной сети
label Текст, используемый для гиперссылки

Заполнить цвета можно в частичном файле _sass/basically-basic/_icons.scss, где имя класса соответствует соответствующему значку.

Например, значку Twitter присваивается цвет заливки #1da1f2 следующим образом:

<span class="icon icon--twitter">{% include icon-twitter.svg %}</span>

Наряду с активами SVG есть вспомогательные включения значков, которые помогают создавать ссылки на социальные сети.

В качестве примера рассмотрим включение icon-github.html:

{% include icon-github.html username=jekyll label='GitHub' %}

Будет выведен следующий HTML:

<a href="https://github.com/jekyll">
  <span class="icon icon--github"><svg viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414"><path d="M8 0C3.58 0 0 3.582 0 8c0 3.535 2.292 6.533 5.47 7.59.4.075.547-.172.547-.385 0-.19-.007-.693-.01-1.36-2.226.483-2.695-1.073-2.695-1.073-.364-.924-.89-1.17-.89-1.17-.725-.496.056-.486.056-.486.803.056 1.225.824 1.225.824.714 1.223 1.873.87 2.33.665.072-.517.278-.87.507-1.07-1.777-.2-3.644-.888-3.644-3.953 0-.873.31-1.587.823-2.147-.09-.202-.36-1.015.07-2.117 0 0 .67-.215 2.2.82.64-.178 1.32-.266 2-.27.68.004 1.36.092 2 .27 1.52-1.035 2.19-.82 2.19-.82.43 1.102.16 1.915.08 2.117.51.56.82 1.274.82 2.147 0 3.073-1.87 3.75-3.65 3.947.28.24.54.73.54 1.48 0 1.07-.01 1.93-.01 2.19 0 .21.14.46.55.38C13.71 14.53 16 11.53 16 8c0-4.418-3.582-8-8-8"></path></svg></span>
  <span class="label">GitHub</span>
</a>
``` **Перейдите** в корневую папку репозитория (например, `jekyll-theme-basically-basic`).

**Запустите** команду `bundle exec rake preview` и откройте браузер по адресу 
`http://localhost:4000/example/`.

Это запустит сервер Jekyll с использованием файлов темы и содержимого каталога `example/`. По мере внесения изменений обновляйте страницу браузера, чтобы увидеть изменения.

## Вклад

Нашли опечатку в документации? Хотите добавить функцию или исправить ошибку? Тогда обязательно **отправьте сообщение о проблеме** [issues] или попробуйте отправить **запрос на вытягивание** [new-issue]. Если это ваш первый запрос на вытягивание, может быть полезно ознакомиться с GitHub Flow [github-flow].

[issues]: https://github.com/mmistakes/jekyll-theme-basically-basic/issues
[new-issue]: https://github.com/mmistakes/jekyll-theme-basically-basic/issues/new
[github-flow]: https://guides.github.com/introduction/flow/

### Запросы на вытягивание

При отправке запроса на вытягивание:

1. Клонируйте репозиторий.
2. Создайте ветку от `master` и дайте ей осмысленное имя (например,
   `my-awesome-new-feature`) и опишите функцию или исправление.
3. Отправьте запрос на вытягивание на GitHub.

Примеры страниц можно найти в папках `/docs` и `/example`, если вы хотите заняться «лёгкими задачами», такими как исправление опечаток, плохой грамматики и т. д.

---

## Авторы

### Создатель

**Майкл Роуз**

- <https://mademistakes.com>
- <https://twitter.com/mmistakes>
- <https://github.com/mmistakes>

### Иконки + демонстрационные изображения:

- [Simple Icons](https://simpleicons.org/)
- [Noun Project](https://thenounproject.com)
- [Unsplash](https://unsplash.com/)

### Прочее:

- [Jekyll](http://jekyllrb.com/)
- [Susy](http://susy.oddbird.net/)
- [Breakpoint](http://breakpoint-sass.com/)

---

## Лицензия

Лицензия MIT (MIT)

Авторские права (c) 2017–2018 Майкл Роуз и участники проекта.

Настоящим предоставляется разрешение любому лицу, получившему копию данного программного обеспечения и сопутствующей документации («Программное обеспечение»), использовать Программное обеспечение без ограничений, включая право на использование, копирование, изменение, объединение, публикацию, распространение, сублицензирование и/или продажу копий Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, выполнять эти действия при соблюдении следующих условий:

Вышеупомянутое уведомление об авторских правах и данное разрешение должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ КОНКРЕТНОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УЩЕРБ ИЛИ ДРУГИЕ ОБЯЗАТЕЛЬСТВА, ВОЗНИКАЮЩИЕ ИЗ, СВЯЗАННЫЕ С ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ В ОТНОШЕНИИ ПРОГРАММНОГО ОБЕПЕЧЕНИЯ.

Basically Basic включает иконки из [The Noun Project](https://thenounproject.com/).
Иконки распространяются под лицензией Creative Commons Attribution 3.0 United States (CC BY 3.0 US).

Basically Basic включает фотографии из [Unsplash](https://unsplash.com).

Basically Basic использует [Susy](http://susy.oddbird.net/),
авторские права (с) 2017, Мириам Эрик Сюзанн.
Susy распространяется на условиях [лицензии BSD 3-clause «New» или «Revised»](https://opensource.org/licenses/BSD-3-Clause).

Basically Basic использует [Breakpoint](http://breakpoint-sass.com/).
Breakpoint распространяется на условиях лицензий [MIT/GPL](http://opensource.org/licenses/MIT).

Комментарии ( 0 )

Вы можете оставить комментарий после Вход в систему

Введение

Ваша новая тема Jekyll по умолчанию. Развернуть Свернуть
SCSS и 4 других языков
MIT
Отмена

Обновления

Пока нет обновлений

Участники

все

Недавние действия

Загрузить больше
Больше нет результатов для загрузки
1
https://api.gitlife.ru/oschina-mirror/chen_ke_715-chen_ke_715.git
git@api.gitlife.ru:oschina-mirror/chen_ke_715-chen_ke_715.git
oschina-mirror
chen_ke_715-chen_ke_715
chen_ke_715-chen_ke_715
gh_pages