# Chirpy Jekyll Theme A minimal, responsive, and feature-rich Jekyll theme for technical writing. [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)][gem]  [![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg?branch=master&event=push)][ci]  [![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)][codacy]  [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)][license]  [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) [**Live Demo** →][demo] [![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]
## Features - Dark / Light Theme Mode - Localized UI language - Pinned Posts on Home Page - Hierarchical Categories - Trending Tags - Table of Contents - Last Modified Date - Syntax Highlighting - Mathematical Expressions - Mermaid Diagrams & Flowcharts - Dark / Light Mode Images - Embed Videos - Disqus / Giscus / Utterances Comments - Built-in Search - Atom Feeds - PWA - Google Analytics / GoatCounter - SEO & Performance Optimization ## Documentation To learn how to use, develop, and upgrade the project, please refer to the [Wiki][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, see the "[Contributing Guidelines][contribute-guide]". ## Credits ### Contributors Thanks to [all the contributors][contributors] involved in the development of the project! [![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors] —— Made with [contrib.rocks](https://contrib.rocks) ### Third-Party Assets This project is built on the [Jekyll][jekyllrb] ecosystem and some [great libraries][lib], and is developed using [VS Code][vscode] as well as tools provided by [JetBrains][jetbrains] under a non-commercial open-source software license. The avatar and favicon for the project's website are from [ClipartMAX][clipartmax]. ## License This project is published under [MIT License][license]. [gem]: https://rubygems.org/gems/jekyll-theme-chirpy [ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster [codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade [license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE [jekyllrb]: https://jekyllrb.com/ [clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/ [demo]: https://cotes2020.github.io/chirpy-demo/ [wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki [contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md [contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors [lib]: https://github.com/cotes2020/chirpy-static-assets [vscode]: https://code.visualstudio.com/ [jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy