<!-- markdownlint-disable-next-line -->
<div align="center">

  <!-- markdownlint-disable-next-line -->
  # Chirpy Hugo Theme

  A hugo version of [Chirpy Jekyll Theme]([chirpy-jekyll]). A minimal, responsive, and feature-rich Hugo theme for technical writing.

  [**Live Demo** →][demo] | [**Jekyll Theme** →][chirpy-jekyll]

  [![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]

</div>

## 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][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][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][contribute-guide]".

## Credits

Thanks to the theme [Chirpy Jekyll Theme][chirpy-jekyll] and all its contributors.

## License

This project is published under [MIT License][license].

[chirpy-jekyll]: https://github.com/cotes2020/jekyll-theme-chirpy
[license]: https://github.com/geekifan/hugo-theme-chirpy/blob/main/LICENSE
[hugo]: https://gohugo.io/
[demo]: https://github.com/geekifan/
[wiki]: https://github.com/geekifan/
[contribute-guide]: https://github.com/geekifan/