diff --git a/README.md b/README.md index 299753e..dfa395e 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,21 @@ - +
- - # Chirpy Hugo Theme +# 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] +A Hugo version of the [Chirpy Jekyll Theme](https://github.com/cotes2020/jekyll-theme-chirpy)
-## 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 -- 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 +# Comprofix -## Quick Start -Use this template: [geekifan/chirpy-starter](https://github.com/geekifan/chirpy-starter) +This repository contains all merges and changes from my development repository so it can be used as a module for the [comprofix.com](https://comprofix.com) website. -## Documentation +## Related Repositories -To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki]. +- **Development branch:** [comprofix/hugo-theme-chirpy](https://github.com/comprofix/hugo-theme-chirpy) +- **Original fork:** [geekifan/hugo-theme-chirpy/](https://github.com/geekifan/hugo-theme-chirpy/) -## 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. - -## 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://geekifan.github.io/chirpy-starter -[wiki]: https://geekifan.github.io/chirpy-starter \ No newline at end of file