По сути, Basic — это тема Jekyll, предназначенная для замены стандартной Minima, с несколькими улучшениями, добавленными для удобства:
Если вы используете Jekyll v3.5+ и используете самостоятельный хостинг, вы можете быстро установить тему как драгоценный камень Ruby. Если вы размещаете страницы GitHub, вы можете установить их как удаленную тему или напрямую скопировать все файлы темы (см. структуру ниже) в свой проект.
Добавьте эту строку в Gemfile
вашего сайта Jekyll:
gem "jekyll-theme-basically-basic"
Добавьте эту строку в файл _config.yml
вашего сайта Jekyll:
theme : jekyll-theme-basically-basic
Затем запустите Bundler, чтобы установить драгоценный камень темы и зависимости:
bundle install
В GitHub Pages добавлена полная поддержка любой темы, размещенной на GitHub.
Замените gem "jekyll"
на:
gem "github-pages" , group : :jekyll_plugins
Запустите bundle update
и убедитесь, что все драгоценные камни установлены правильно.
Добавьте remote_theme: "mmistakes/[email protected]"
в ваш файл _config.yml
. Удалите любые другие записи theme:
или remote_theme:
Примечание. Ваш сайт Jekyll должен быть доступен для просмотра сразу по адресу http://USERNAME.github.io. Если это не так, вы можете принудительно перестроить сайт, настроив свой сайт (более подробную информацию см. ниже).
Если вы размещаете несколько сайтов на базе Jekyll под одним и тем же именем пользователя GitHub, вам придется использовать страницы проекта вместо страниц пользователя. По сути, вы переименовываете репозиторий во что-то другое, кроме 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 или удаленные версии темы Basic Basic, обновление пройдет довольно безболезненно.
Чтобы проверить, какую версию вы сейчас используете, просмотрите исходный код созданного вами сайта, и вы увидите что-то похожее на:
<!--
Basically Basic Jekyll Theme 1.4.5
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
.
Просто запустите bundle update
, если вы используете Bundler (есть Gemfile
), или gem update jekyll-theme-basically-basic
если вы этого не сделали.
Убедитесь, что вам назначена последняя версия в _config.yml
remote_theme: "mmistakes/[email protected]"
Примечание. Если @xxx
опущен, будет использоваться текущая master
ветка темы. Рекомендуется «заблокировать» remote_theme
в определенной версии, чтобы избежать внесения критических изменений на ваш сайт.
Следующий шаг потребует перестройки вашего сайта GitHub Pages, чтобы он мог получать последние обновления тем. Этого можно добиться, разместив коммит в репозитории GitHub.
Пустой коммит также выполнит свою работу, если в данный момент вам нечего отправлять:
git commit --allow-empty -m "Force rebuild of site"
Если вы хотите получить максимальную отдачу от рабочего процесса 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
В зависимости от количества настроек, которые вы сделали после разветвления, могут возникнуть конфликты слияния. Обработайте все конфликтующие файлы с флагами Git, проинструктируйте изменения, которые вы хотите сохранить, а затем зафиксируйте их.
Другой способ работы с обновлениями — загрузка темы — замена макетов, включений и ресурсов более новыми вручную. Чтобы быть уверенным, что вы не пропустите никаких изменений, вероятно, будет хорошей идеей просмотреть историю коммитов темы и узнать, что изменилось с тех пор.
Вот краткий контрольный список важных папок/файлов, о которых вам следует помнить:
Имя | |
---|---|
_layouts | Заменить все. Примените изменения, если вы настроили какие-либо макеты. |
_includes | Заменить все. Примените изменения, если вы настроили какие-либо включения. |
assets | Заменить все. Примените изменения, если вы настроили таблицы стилей или сценарии. |
_sass | Заменить все. Примените изменения, если вы настроили частичные файлы Sass. |
_data/theme.yml | Безопасно хранить. Убедитесь, что не было никаких серьезных структурных изменений или дополнений. |
_config.yml | Безопасно хранить. Убедитесь, что не было никаких серьезных структурных изменений или дополнений. |
Примечание. Если вы не видите последнюю версию, обязательно очистите кеши браузера и CDN. В зависимости от вашей среды хостинга старые версии /assets/css/main.css
, /assets/js/main.js
или *.html
могут кэшироваться.
Макеты, включения, частичные файлы Sass и файлы данных размещаются в местах по умолчанию. Таблицы стилей и скрипты в assets
, а также несколько файлов, связанных с разработкой, в корневом каталоге проекта.
Обратите внимание: если вы установили Basic 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 | Название вашего сайта (например, «Потрясающий сайт Дангана»). |
description | Краткое описание сайта (например, блог о пюре из кузнечиков) |
url | Полный URL-адрес вашего сайта (например, https://groverloaf.org). |
author | Глобальная информация об авторе (см. ниже) |
logo | Путь к логотипу всего сайта ~ 100x100 пикселей (например, /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 |
---|---|---|
skin: sea | skin: soft | skin: steel |
---|---|---|
Эта тема позволяет вам легко использовать 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 links "
skip_primary_nav : " Skip to primary navigation "
skip_content : " Skip to content "
skip_footer : " Skip to footer "
menu : " Menu "
search : " Search "
site_search : " Site Search "
results_found : " Result(s) found "
search_placeholder_text : " Enter your search term... "
home : " Home "
newer : " Newer "
older : " Older "
email : " Email "
subscribe : " Subscribe "
read_more : " Read More "
posts : " Posts "
page : " Page "
of : " of "
min_read : " min read "
present : " Present "
cv_awards : " Awards "
cv_summary_contact : " Contact "
cv_summary_contact_email : " Email "
cv_summary_contact_phone : " Phone "
cv_summary_contact_website : " Website "
cv_location : " Location "
cv_education : " Education "
cv_education_courses : " Courses "
cv_interests : " Interests "
cv_languages : " Languages "
cv_publications : " Publications "
cv_references : " References "
cv_skills : " Skills "
cv_volunteer : " Volunteer "
cv_work : " Work "
По умолчанию все внутренние страницы с title
будут добавлены в меню «вне холста». Для более детального управления и сортировки этих ссылок меню:
Создайте собственный список, чтобы переопределить настройку по умолчанию, добавив массив navigation_pages
в файл /_data/theme.yml
.
Добавьте необработанные пути к страницам в желаемом порядке:
navigation_pages :
- about.md
- cv.md
Заголовок и URL-адрес каждой ссылки меню будут заполнены на основе их title
и permalink
соответственно.
Разбейте основной список сообщений на более мелкие списки и отображайте их на нескольких страницах, включив нумерацию страниц.
Включите плагин jekyll-paginate
в свой Gemfile
.
group :jekyll_plugins do
gem "jekyll-paginate"
end
Добавьте jekyll-paginate
в массив gems
в файле _config.yml
и следующие настройки нумерации страниц:
paginate : 5 # amount of posts to show per page
paginate_path : /page:num/
Создайте index.html
(или переименуйте index.md
) в корне вашего проекта и добавьте следующее вступление:
layout : home
paginate : true
Чтобы включить поиск по всему сайту, добавьте search: true
в ваш _config.yml
.
Поиск по умолчанию использует Lunr для создания индекса поиска всех ваших документов. Этот метод на 100% совместим с сайтами, размещенными на GitHub Pages.
Примечание. В поисковый индекс Lunr добавляются только первые 50 слов основного содержимого сообщения или страницы. Установка для search_full_content
значения true
в вашем _config.yml
переопределит это и может повлиять на производительность загрузки страницы.
Для более быстрого и релевантного поиска (см. демо):
Добавьте драгоценный камень 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
Как только это будет сделано, загрузите все зависимости, запустив bundle install
.
Переключите поставщика поиска с lunr
на algolia
в файле _config.yml
:
search_provider : algolia
Добавьте следующие учетные данные Algolia в файл _config.yml
. Если у вас нет учетной записи Algolia, вы можете открыть бесплатный план сообщества. После входа в систему вы можете получить свои учетные данные с панели управления.
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
После настройки учетных данных вы можете запустить индексацию с помощью следующей команды:
ALGOLIA_API_KEY=your_admin_api_key bundle exec jekyll algolia
Пользователям Windows вам придется использовать set
для назначения переменной среды ALGOLIA_API_KEY
.
set ALGOLIA_API_KEY=your_admin_api_key
bundle exec jekyll algolia
Обратите внимание, что ALGOLIA_API_KEY
должен быть установлен на ваш ключ API администратора.
Чтобы использовать поиск 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 в файл _config.yml
вашего проекта:
disqus :
shortname : my_disqus_shortname
Комментарии включены по умолчанию и появятся в рабочей среде только при сборке со следующим значением среды: JEKYLL_ENV=production
Если вы не хотите отображать комментарии к определенному сообщению, вы можете отключить их, добавив comments: false
в начало сообщения.
Чтобы включить Google Analytics, добавьте свой идентификатор отслеживания в _config.yml
следующим образом:
google_analytics : UA-NNNNNNNN-N
Как и комментарии, скрипт отслеживания Google Analytics будет отображаться в рабочей среде только при использовании следующего значения среды: JEKYLL_ENV=production
.
По умолчанию в строке авторских прав в нижнем колонтитуле отображается текущий год (на момент создания), за которым следует название вашего сайта. например © 2018 Basically Basic.
Если вы хотите изменить это, добавьте copyright
к файлу _config.yml
с соответствующим текстом:
copyright : " My custom copyright. "
Эта тема предоставляет следующие макеты, которые вы можете использовать, установив layout
Front Matter на каждой странице, например:
---
layout : name
---
layout: default
Этот макет обрабатывает всю базовую структуру страницы, размещая содержимое страницы между элементами верхнего и нижнего колонтитула. Все остальные макеты наследуют этот и предоставляют дополнительные стили и функции внутри блока {{ content }}
.
layout: post
Этот макет включает в себя следующую вступительную часть:
# optional alternate title to replace page.title at the top of the page
alt_title : " Basically Basic "
# optional sub-title below the page title
sub_title : " The name says it all "
# optional intro text below titles, Markdown allowed
introduction : |
Basically Basic is a Jekyll theme meant to be a substitute for the default --- [Minima](https://github.com/jekyll/minima). Conventions and features found in Minima are fully supported by **Basically Basic**.
# optional call to action links
actions :
- label : " Learn More "
icon : github # references name of svg icon, see full list below
url : " http://url-goes-here.com "
- label : " Download "
icon : download # references name of svg icon, see full list below
url : " http://url-goes-here.com "
image : # URL to a hero image associated with the post (e.g., /assets/page-pic.jpg)
# post specific author data if different from what is set in _config.yml
author :
name : John Doe
twitter : johndoetwitter
comments : false # disable comments on this post
Примечание. На изображения героев можно наложить прозрачный «акцентный» цвет, чтобы унифицировать их с палитрой темы. Чтобы включить, настройте CSS, используя следующую переопределенную переменную Sass:
$intro-image-color-overlay : true;
layout: page
Визуально этот макет выглядит и действует так же, как и layout: post
, с двумя небольшими отличиями.
layout: home
Этот макет содержит ту же вступительную часть, что и layout: page
, с добавлением следующего:
paginate : true # enables pagination loop, see section above for additional setup
entries_layout : # list (default), 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 : # collection name
entries_layout : # list (default), grid
show_excerpts : # true (default), false
sort_by : # date (default) title
sort_order : # forward (default), reverse
Чтобы создать страницу, показывающую все документы в коллекции recipes
, вы должны создать recipes.md
в корне вашего проекта и добавить следующее:
title : Recipes
layout : collection
permalink : /recipes/
collection : recipes
По умолчанию документы отображаются в виде списка. Чтобы перейти к сеточному виду, добавьте entries_layout: grid
в начало страницы. Если вы хотите отсортировать коллекцию по названию, добавьте sort_by: title
. Если вам нужна обратная сортировка, добавьте sort_order: reverse
.
layout: category
В этом макете отображаются все сообщения, сгруппированные по определенной категории. Он содержит ту же вступительную часть, что и layout: page
с добавлением следующего:
taxonomy : # category name
entries_layout : # list (default), grid
По умолчанию сообщения отображаются в виде списка. Чтобы перейти к сеточному виду, добавьте entries_layout: grid
в начало страницы.
Чтобы создать страницу, показывающую все сообщения, отнесенные к категории foo
вы должны создать foo.md
в корне вашего проекта и добавить следующее:
title : Foo
layout : category
permalink : /categories/foo/
taxonomy : foo
layout: tag
В этом макете отображаются все публикации, сгруппированные по определенному тегу. Он содержит ту же вступительную часть, что и layout: page
с добавлением следующего:
taxonomy : # tag name
entries_layout : # list (default), grid
По умолчанию сообщения отображаются в виде списка. Чтобы перейти к сеточному виду, добавьте entries_layout: grid
в начало страницы.
Чтобы создать страницу, показывающую все сообщения, присвоенные тегу foo bar
вы должны создать foo-bar.md
в корне вашего проекта и добавить следующее:
title : Foo Bar
layout : tag
permalink : /tags/foo-bar/
taxonomy : foo bar
layout: about
В этом макете используется та же вступительная часть, что и layout: page
, с добавлением следующего элемента для отображения изображения автора:
author :
name : John Doe
picture : /assets/images/johndoe.png
Рекомендуемый размер picture
— примерно 300 x 300
пикселей. Если объект author
не задан явно в начале страницы, тема по умолчанию будет использовать значение, установленное в _config.yml
.
Если поле пустое, изображение не появится.
layout: cv
Этот макет содержит ту же вступительную часть, что и layout: page
. Он использует стандарт файлов на основе JSON для данных резюме, чтобы удобно отображать резюме или безболезненно резюме.
Просто используйте встроенный в браузер конструктор резюме 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 Basic Basic в <your_project>/_includes
и начните редактировать этот файл. Совет: чтобы найти файлы темы на вашем компьютере, запустите bundle info jekyll-theme-basically-basic
. Это возвращает расположение файлов темы на основе драгоценных камней.
Чтобы переопределить Sass по умолчанию (расположенный в каталоге _sass
темы), выполните одно из следующих действий:
Скопируйте непосредственно из драгоценного камня Basic Basic.
bundle info jekyll-theme-basically-basic
чтобы получить путь к нему)./assets/stylesheets/main.scss
оттуда в <your_project>
.<your_project>/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 по умолчанию, выполните одно из следующих действий:
Скопируйте непосредственно из драгоценного камня Basic Basic.
bundle info jekyll-theme-basically-basic
чтобы получить путь к нему)./assets/javascripts/main.js
оттуда в <your_project>
.<your_project>/assets/javascripts/main.js
.Скопируйте из этого репо.
<your_project>
.<your_project>/assets/javascripts/main.js
. В теме используются логотипы социальных сетей и другая иконография, сохраненная в формате SVG, для обеспечения производительности и гибкости. Указанные файлы SVG расположены в каталоге _includes
и имеют префикс icon-
. Каждый значок имеет размер и дизайн, соответствующий размеру окна просмотра 16 x 16
, и оптимизирован с помощью SVGO.
Икона | Имя файла |
---|---|
значок-стрелка-left.svg | |
значок-стрелка-right.svg | |
значок-bitbucket.svg | |
значок-календарь.svg | |
значок-codepen.svg | |
значок-download.svg | |
значок-dribbble.svg | |
значок-email.svg | |
значок-facebook.svg | |
значок-flickr.svg | |
значок-github.svg | |
значок-gitlab.svg | |
значок-googleplus.svg | |
значок-instagram.svg | |
значок-lastfm.svg | |
значок-linkedin.svg | |
значок-pdf.svg | |
значок-pinterest.svg | |
значок-rss.svg | |
значок-soundcloud.svg | |
значок-stackoverflow.svg | |
значок-секундомер.svg | |
значок-tumblr.svg | |
значок-twitter.svg | |
значок-xing.svg | |
значок-youtube.svg |
Цвета заливки определяются в партиале _sass/basically-basic/_icons.scss
и задаются с помощью .icon-name
, где имя класса соответствует соответствующему значку.
Например, значку Twitter присвоен цвет заливки #1da1f2
, например:
< span class =" icon icon--twitter " > {% include icon-twitter.svg %} </ span >
Помимо ресурсов SVG, существуют вспомогательные иконки, помогающие создавать ссылки на социальные сети.
Включить параметр | Описание | Необходимый |
---|---|---|
username | Имя пользователя в данной социальной сети | Необходимый |
label | Текст, используемый для гиперссылки | Необязательно, по умолчанию username |
Например, следующий 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 >
Чтобы настроить среду для разработки этой темы:
cd
в /example
и запустите bundle install
.Чтобы протестировать тему локально по мере внесения в нее изменений:
cd
в корневую папку репозитория (например, jekyll-theme-basically-basic
).bundle exec rake preview
и откройте в браузере http://localhost:4000/example/
. Это запустит сервер Jekyll, использующий файлы темы и содержимое каталога example/
. По мере внесения изменений обновите браузер, чтобы увидеть любые изменения.
Нашли опечатку в документации? Хотите добавить функцию или исправить ошибку? Затем непременно сообщите о проблеме или попытайтесь отправить запрос на включение. Если это ваш первый запрос на включение, возможно, будет полезно прочитать GitHub Flow.
При отправке запроса на включение:
master
и дайте ей осмысленное имя (например, my-awesome-new-feature
) и опишите функцию или исправление. Примеры страниц можно найти в папках /docs
и /example
если вы хотите заняться любыми «легкими задачами», такими как исправление опечаток, плохой грамматики и т. д.
Майкл Роуз
Лицензия MIT (MIT)
Авторские права (c) 2017–2021 г. Майкл Роуз и участники
Настоящим разрешение бесплатно предоставляется любому лицу, получившему копию этого программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), на использование Программного обеспечения без ограничений, включая, помимо прочего, права на использование, копирование, изменение, объединение. публиковать, распространять, сублицензировать и/или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставлено Программное обеспечение, делать это при соблюдении следующих условий:
Вышеупомянутое уведомление об авторских правах и данное уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.
ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ, ГАРАНТИЯМИ ТОВАРНОЙ ЦЕННОСТИ, ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ И НЕНАРУШЕНИЯ ПРАВ. НИ ПРИ КАКИХ ОБСТОЯТЕЛЬСТВАХ АВТОРЫ ИЛИ ОБЛАДАТЕЛИ АВТОРСКИХ ПРАВ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ЗА ЛЮБЫЕ ПРЕТЕНЗИИ, УБЫТКИ ИЛИ ДРУГУЮ ОТВЕТСТВЕННОСТЬ, БУДЬ В ДЕЙСТВИЯХ ПО КОНТРАКТУ, ПРАВОНАРУШЕНИЮ ИЛИ ДРУГИМ ОБРАЗОМ, ВОЗНИКАЮЩИЕ ОТ, ИЗ ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ СДЕЛКАМИ, ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ.
В основном Basic включает в себя значки из The Noun Project. Иконки распространяются по лицензии Creative Commons Attribution 3.0 United States (CC BY 3.0 US).
В основном Basic включает фотографии из Unsplash.
В состав Basic Basic входит Susy, Copyright (c) 2017, Мириам Эрик Сюзанн. Susy распространяется на условиях «Новой» или «Пересмотренной» лицензии BSD, состоящей из 3 пунктов.
В основном Basic включает точку останова. Breakpoint распространяется на условиях лицензий MIT/GPL.