simplest jekyll

Самый простой Джекилл

Минимальный сайт на основе Jekyll на страницах GH, уменьшенный до одной страницы контента с темой

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

О

Это шаблон и живой демонстрационный проект. Это показывает, как мало вам нужно настроить, чтобы получить сайт Jekyll на страницах GH.

• index.md
  • Для домашней страницы - единственная страница в этом случае.
  • Если вы оставите эту страницу, то README.md будет использоваться в качестве домашней страницы.
• _config.yml
  • Установите тему - это обрабатывает макет и стиль.
  • Включить плагин Jekyll Sitemap - включить его в Gemfile недостаточно. Обратите внимание, что другие плагины будут включены для вас, как необязательный фронт.
  • Другие стандартные значения, такие как baseurl , title и description были оставлены вне конфигурации. При настройке на страницах GH они будут выведены для вас GH Gem Gem.
• Gemfile
  • Это на самом деле не используется страницами GH, но позволяет вам устанавливать тему Jekyll локально с помощью Bundler.
  • Используйте одну github-pages если вы хотите соответствовать всем драгоценным камням на страницах GH (которые могут быть тяжелыми для установки).
  • Удалите этот файл, если вам не нужно запускать свой сайт локально.

Если вам нужен более полноценной пример многостраничного сайта с постами, драгоценными камнями, макетами и т. Д. Затем проверьте мою репо-репо-блог-блог-блог. Это можно использовать в качестве шаблона и демонстрационного сайта.

Как использовать этот проект

Настраивать

1. Нажмите «Используйте этот шаблон , чтобы создать новую репо в своей собственной учетной записи». Вы можете оставить имя как simplest-jekyll .
2. Включите страницы GitHub в настройках вашего репо. Выберите, чтобы служить из master ветви и варианта / path.
3. Проверьте вкладку «Среда репо», чтобы увидеть, когда сделано развертывание.
4. Нажмите «Посмотреть развертывание», чтобы увидеть живой сайт. например https://michaelcurrin.github.io/simplest-jekyll/

Обратите внимание, что /simplest-jekyll/index.html доступен немедленно, но это займет несколько минут, пока страницы Github не сделают /simplest-jekyll/ доступны.

Настраивать

• Обновите README.md с помощью ваших собственных деталей. Это на самом деле не используется на развертываемом сайте, но видно на месте и на GitHub.
• Темы
  • Отредактируйте тему в _config.yml, если вы хотите еще одну тему.
  • Вы также можете использовать раздел Github Pages настройки репо для визуального просмотра.
  • Примечание только темы, поддерживаемые страницами GitHub, покрыты (около 10), но если вы используете поле remote_theme в своей конфигурации, вы можете ссылаться на больше темт.
  • Для установки и запуска локально вам нужно убедиться, что ваш Gemfile охватывает тему, используемую в конфигурации.
• Как и в большинстве сайтов Jekyll, index.md используется в качестве домашней страницы.
  • Он имеет переднюю вещество вверху, поэтому любая жидкость будет применена.
  • Отредактируйте свой файл index.md с помощью собственного контента как HTML или Markdown.
  • Вы можете переименовать его в index.html если вы хотите только простой HTML.
  • Вы можете удалить переднее вещество сверху, чтобы удалить форматирование жидкости и любую тематическую.
• Если вы хотите, добавьте больше страниц в корне и разбейте любой общий HTML, такой как заголовок, головка или навигация в папку _includes или папку _layouts (ни один из них не рассматривается в объеме этого проекта, но является обычным явлением для проектов Jekyll).
• Смотрите документы и учебные пособия на сайте Jekyll для получения дополнительной информации.
• При желании запустить Jekyll локально:
  • Установите Ruby и Bundler.
  • Установите проектные драгоценные камни - Jekyll и Theme Gem.
  • Запустите Jekyll Dev Server.
  • Для получения более полных инструкций см. Docs of Jekyll Blog Demo. Вам также нужно добавить Makefile , чтобы соответствовать этим командам.

Связанные проекты

• - Блог по умолчанию, сгенерированный с Jekyll CLI. Использование темы, контента, настройки стиля, драгоценных камней и makefile.
• - Использование Jekyll 4, тема, Github Deciates и Github Pages.
• - Минимальный сайт Jekyll с темой, но без Gemfile.

Лицензия

Выпущен под MIT @michaelcurrin.