83 lines
3.3 KiB
Markdown
83 lines
3.3 KiB
Markdown
<!-- markdownlint-disable-next-line -->
|
|
<div align="center">
|
|
|
|
<!-- markdownlint-disable-next-line -->
|
|
# Chirpy Jekyll Theme
|
|
|
|
A minimal, responsive, and feature-rich Jekyll theme for technical writing.
|
|
|
|
[][gem]
|
|
[][ci]
|
|
[][codacy]
|
|
[][license]
|
|
[](https://996.icu)
|
|
|
|
[**Live Demo** →][demo]
|
|
|
|
[][demo]
|
|
|
|
</div>
|
|
|
|
## 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][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
|
|
|
|
### Contributors
|
|
|
|
Thanks to [all the contributors][contributors] involved in the development of the project!
|
|
|
|
[][contributors]
|
|
<sub> — Made with [contrib.rocks](https://contrib.rocks)</sub>
|
|
|
|
### Third-Party Assets
|
|
|
|
This project is built on the [Jekyll][jekyllrb] ecosystem and some [great libraries][lib], and is developed using [VS Code][vscode] as well as tools provided by [JetBrains][jetbrains] under a non-commercial open-source software license.
|
|
|
|
The avatar and favicon for the project's website are from [ClipartMAX][clipartmax].
|
|
|
|
## License
|
|
|
|
This project is published under [MIT License][license].
|
|
|
|
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
|
|
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster
|
|
[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
|
|
[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE
|
|
[jekyllrb]: https://jekyllrb.com/
|
|
[clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/
|
|
[demo]: https://cotes2020.github.io/chirpy-demo/
|
|
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
|
|
[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md
|
|
[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors
|
|
[lib]: https://github.com/cotes2020/chirpy-static-assets
|
|
[vscode]: https://code.visualstudio.com/
|
|
[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy
|