web/README.md
Cotes Chung 926d1ca068
docs: update tutorial & readme (#1110)
- update feature list in README
- add screenshots to tutorial
2023-06-27 00:39:42 +08:00

3.6 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 view features

  • Dark / Light Theme Mode
  • Localized UI language
  • Pinned Posts
  • Hierarchical Categories
  • Trending Tags
  • Table of Contents
  • Last Modified Date of Posts
  • Syntax Highlighting
  • Mathematical Expressions
  • Mermaid Diagram & Flowchart
  • Dark / Light Mode Images
  • Embed Videos
  • Disqus / Utterances / Giscus Comments
  • Search
  • Atom Feeds
  • Google Analytics
  • SEO & Performance Optimization

Documentation

To explore usage, development, and upgrade guide of the project, please refer to the Wiki.

Contributing

Welcome to report bugs, help improve the code or submit new features. For more information, please 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.

Thanks to all the contributors. Also, folks who submitted issues or unmerged PRs should not be forgotten. Because they reported bugs, shared ideas, or inspired me to write more readable documentation.

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

Sponsoring

If you'd like to sponsor this project, the following options are available.

Ko-fi Wechat Pay Alipay

License

This work is published under MIT License.