web/README.md
2023-09-27 21:03:12 +08:00

3.7 KiB

Chirpy Jekyll Theme

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

Gem Version  CI  Codacy Badge  GitHub license  996.icu

Live Demo →

Devices Mockup

Features

Click to expand/close details  
  • 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
  • SEO & Performance Optimization

Documentation

To explore usage, development, and upgrade guide of 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, see the "Contributing Guidelines".

Credits

This theme is mainly built with Jekyll ecosystem, Bootstrap, Font Awesome and some other wonderful tools. The avatar and favicon design come from Clipart Max.

Many thanks to the contributors who participated in the development and to the folks who reported bugs or shared ideas.

Last but not least, thanks to JetBrains for providing the Open Source License.

Sponsoring

If you like this project, or have built something through it, please consider supporting me in the following ways. Any support would be greatly appreciated!

Ko-fi  Wechat Pay  Alipay

License

This work is published under MIT License.