web/README.md
2023-10-23 05:41:55 +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 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, see the "Contributing Guidelines".

Credits

This project was built primarily with the Jekyll ecosystem, Bootstrap, Font Awesome, and some other wonderful tools. The avatar and favicon design 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 sponsoring it, and your support would be greatly appreciated.

Ko-fi  Wechat Pay  Alipay

License

This project is published under MIT License.