minimal

Минимальная тема

Minimal — это тема Jekyll для страниц GitHub. Вы можете предварительно просмотреть тему, чтобы увидеть, как она выглядит, или даже использовать ее сегодня.

Использование

Чтобы использовать тему «Минимализм»:

1. Добавьте следующее в _config.yml вашего сайта:

    remote_theme : pages-themes/[email protected]
   plugins :
   - jekyll-remote-theme # add this line to the plugins list if you already have one

2. При желании, если вы хотите просмотреть свой сайт на своем компьютере, добавьте следующее в Gemfile вашего сайта:

    gem "github-pages" , group : :jekyll_plugins 

Настройка

Переменные конфигурации

Minimal будет учитывать следующие переменные, если они установлены в _config.yml вашего сайта:

 title : [The title of your site]
description : [A short description of your site's purpose]

Кроме того, вы можете установить следующие дополнительные переменные:

 show_downloads : ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics : [Your Google Analytics tracking ID]

Таблица стилей

Если вы хотите добавить свои собственные стили:

1. Создайте файл с именем /assets/css/style.scss на своем сайте.
2. Добавьте следующий контент в начало файла, точно так, как показано:

   ---
   ---
   
   @import " {{ site.theme }} " ;

3. Добавьте любой собственный CSS (или Sass, включая импорт), который вам нужен, сразу после строки @import .

Примечание. Если вы хотите изменить переменные Sass темы, вам необходимо установить новые значения перед строкой @import в вашей таблице стилей.

Макеты

Если вы хотите изменить HTML-разметку темы:

1. Для некоторых изменений, таких как пользовательский favicon , вы можете добавить собственные файлы в локальную папку _includes . Файлы, прилагаемые к теме, служат отправной точкой и включаются в исходный шаблон макета.
2. Для более масштабных изменений скопируйте исходный шаблон из репозитория темы.
   ( Совет: нажмите «raw», чтобы упростить копирование )
3. Создайте на своем сайте файл с именем /_layouts/default.html
4. Вставьте содержимое макета по умолчанию, скопированное на первом шаге.
5. Настройте макет по своему усмотрению

Настройка кода Google Analytics

За годы, прошедшие с момента создания этой темы, Google выпустил несколько итераций своего кода Google Analytics. Если вы хотите воспользоваться новейшим кодом, вставьте его в _includes/head-custom-google-analytics.html на своем сайте Jekyll.

Переопределение URL-адресов, сгенерированных GitHub

Шаблоны часто используют URL-адреса, предоставленные GitHub, например ссылки на ваш репозиторий или ссылки для загрузки вашего проекта. Если вы хотите переопределить один или несколько URL-адресов по умолчанию:

1. Посмотрите исходный код шаблона, чтобы определить имя переменной. Это будет в виде {{ site.github.zip_url }} .
2. Укажите URL-адрес, который вы хотите использовать в шаблоне, в _config.yml вашего сайта. Например, если бы переменная была site.github.url , вы бы добавили следующее:

    github :
     zip_url : http://example.com/download.zip
     another_url : another value

3. Когда ваш сайт будет создан, Jekyll будет использовать указанный вами URL-адрес, а не URL-адрес по умолчанию, предоставленный GitHub.

Примечание. Вам необходимо удалить site. префикс, а каждое имя переменной (после github. ) должно быть с отступом в два пробела ниже github: .

Дополнительную информацию см. в документации по переменным Jekyll.

Дорожная карта

Список предлагаемых функций (и известных проблем) см. в разделе «Открытые проблемы».

Философия проекта

Тема Minimal предназначена для того, чтобы пользователи GitHub Pages могли быстро и легко создать свой первый (или сотый) веб-сайт. Тема должна отвечать подавляющему большинству потребностей пользователей «из коробки», склоняясь скорее к простоте, чем к гибкости, и предоставлять пользователям возможность выбрать дополнительную сложность, если у них есть особые потребности или они хотят дополнительно настроить свой опыт. (например, добавление пользовательского CSS или изменение макета по умолчанию). Это также должно выглядеть великолепно, но это само собой разумеется.

Содействие

Хотите внести свой вклад в Minimal? Мы будем рады вашей помощи. Minimal — это проект с открытым исходным кодом, в который такие пользователи, как вы, вносят по одному вкладу. Инструкции о том, как внести свой вклад, см. в файле CONTRIBUTING.

Предварительный просмотр темы локально

Если вы хотите просмотреть тему локально (например, в процессе предложения изменения):

1. Клонируйте репозиторий темы ( git clone https://github.com/pages-themes/minimal ).
2. cd в каталог темы
3. Запустите script/bootstrap чтобы установить необходимые зависимости.
4. Запустите bundle exec jekyll serve , чтобы запустить сервер предварительного просмотра.
5. Посетите localhost:4000 в своем браузере, чтобы просмотреть тему.

Запуск тестов

Тема содержит минимальный набор тестов, гарантирующий успешное создание сайта с этой темой. Чтобы запустить тесты, просто запустите script/cibuild . Вам нужно будет запустить script/bootstrap один раз, прежде чем тестовый скрипт заработает.