Files
hugo-theme-chirpy/README.md
2025-04-28 22:20:23 +08:00

2.0 KiB

Chirpy Hugo Theme

A hugo version of Chirpy Jekyll Theme. A minimal, responsive, and feature-rich Hugo theme for technical writing.

Live Demo | Jekyll Theme

Devices Mockup

Attention

⚠️ This theme is still under active development. Some of its features will be available soon. It will become stable in May, 2025. (I've implemented 90% of its features till now).

Features

  • Native i18n Support (thanks to Hugo)
  • Dark Theme
  • Localized UI language
  • Pinned Posts on Home Page
  • Hierarchical Categories
  • Trending Tags
  • Table of Contents
  • Last Modified Date
  • Syntax Highlighting (🚧 Work in Progress)
  • Mathematical Expressions
  • Mermaid Diagrams & Flowcharts (🚧 Work in Progress)
  • Dark Mode Images
  • Embed Media
  • Comment Systems (🙋‍♂️ Call for Test)
  • Built-in Search
  • RSS Feeds
  • PWA (🚧 Work in Progress)
  • 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

Thanks to the theme Chirpy Jekyll Theme and all its contributors.

License

This project is published under MIT License.