web/README.md
2024-06-05 01:12:25 +08:00

3.5 KiB

Chirpy Jekyll Theme

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

Open in Dev Containers  Gem Version  GitHub license  CI  Codacy Badge

Live Demo

Devices Mockup

Features

  • Dark Theme
  • 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 Mode Images
  • Embed Media
  • Comment Systems
  • Built-in Search
  • Atom Feeds
  • PWA
  • Web 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

Contributors

Thanks to all the contributors involved in the development of the project!

all-contributors — Made with contrib.rocks

Third-Party Assets

This project is built on the Jekyll ecosystem and some great libraries, and is developed using VS Code as well as tools provided by JetBrains under a non-commercial open-source software license.

The avatar and favicon for the project's website are from ClipartMAX.

License

This project is published under MIT License.