jekyll-theme-chirpy README

The project's README from github.com/cotes2020/jekyll-theme-chirpy. As one markdown file: README.md.

Chirpy Jekyll Theme

A minimal, responsive, and feature-rich Jekyll theme for technical writing.

CI  Codacy Badge  GitHub license  Gem Version  Open in Dev Containers

Live Demo →

Devices Mockup

Features

Documentation

To learn how to use, develop, and upgrade the project, please refer to the Wiki.

Contributing

Contributions (pull requests, issues, and discussions) are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For details, please refer to our Contributing Guidelines.

Credits

This project is built on the Jekyll ecosystem and integrates a collection of excellent libraries. Its avatar and favicon are sourced from ClipartMAX.

Furthermore, thanks to everyone who contributed to the development of this project!

all-contributors

License

This project is licensed under the MIT License.

jekyll-theme-chirpy (cotes2020/jekyll-theme-chirpy)

Searching Database…

Что это такое?Chirpy — это минималистичная, адаптивная и богатая на возможности тема для Jekyll, созданная для технических текстов: готовый дизайн и набор функций для статических блогов.
Это готовый блог или дизайн, на основе которого я строю сайт?Это тема для генератора статических сайтов Jekyll: вы строите сайт на её основе, а Jekyll собирает статические страницы; тема распространяется как Ruby-гем.
Как запустить с ней блог?Wiki проекта — основной справочник по использованию, разработке и обновлению темы; в README также есть настройка в один клик «Open in Dev Containers».
Что нужно установить, чтобы собрать и посмотреть сайт локально?Ruby с Jekyll для сборки сайта плюс Node.js для фронтенд-ассетов (rollup собирает JS, PurgeCSS урезает CSS); в основе лежит UI-фреймворк Bootstrap.
К чему мне стоит быть готовым в начале?Установка в одну команду не предусмотрена: придётся настроить сборочную цепочку из Ruby/Jekyll и Node, а кастомизация — это правка шаблонов и SCSS, а не переключение настроек.
Где можно разместить готовый сайт?Везде, где можно раздавать статические файлы: Jekyll выдаёт обычный статический сайт (проект делает ставку на jamstack), который работает в любом современном браузере.
Что читатели получают на сайте из коробки?Заранее подключены поиск, на выбор несколько систем комментариев и Atom-ленты, а также поддержка PWA, встроенная веб-аналитика и продвинутое SEO.
Что можно вставлять в свои посты?Подсветку кода, математические выражения, диаграммы и блок-схемы Mermaid, встроенные медиа; для организации есть закреплённые посты, древовидные категории, популярные теги, автоматически генерируемое оглавление и даты последнего изменения.
Есть ли поддержка блогов не на английском и тёмная тема?Да — язык интерфейса можно локализовать, а в тему входят тёмный и светлый режимы плюс изображения для тёмной темы.
Creator
cotes2020
Size
5.6 MB
Stars
10.3K
Age
7y
Commits · 90 Days