web/README.md

95 lines
3.7 KiB
Markdown
Raw Normal View History

2021-07-19 17:24:04 +03:00
<div align="center">
2021-09-29 15:44:17 +03:00
# Chirpy Jekyll Theme
A minimal, responsive and feature-rich Jekyll theme for technical writing.
2021-11-26 18:29:51 +03:00
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)][gem]&nbsp;
[![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg?branch=master&event=push)][ci]&nbsp;
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)][codacy]&nbsp;
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)][license]&nbsp;
2021-09-29 15:44:17 +03:00
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
2021-07-19 17:24:04 +03:00
[**Live Demo →**][demo]
2021-09-29 15:44:17 +03:00
[![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]
2021-09-29 15:44:17 +03:00
</div>
2020-04-12 19:38:56 +03:00
## Features
2019-09-30 15:37:14 +03:00
<details>
<summary>
<i>Click to view features</i>
</summary>
<p>
- Dark / Light Theme Mode
- 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 / Light Mode Images
- Embed Videos
- Disqus / Utterances / Giscus Comments
- Built-in Search
- Atom Feeds
- Google Analytics
- SEO & Performance Optimization
</p>
</details>
2021-01-25 15:19:50 +03:00
## Documentation
To explore usage, development, and upgrade guide of the project, please refer to the [**Wiki**][wiki].
## Contributing
Contributions (Issues/PRs/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
2019-09-30 15:37:14 +03:00
This theme is mainly built with [Jekyll][jekyllrb] ecosystem,
[Bootstrap][bootstrap], [Font Awesome][icons] and some other [wonderful tools][lib].
The avatar and favicon design come from [Clipart Max][image].
2019-11-05 17:14:02 +03:00
Many thanks to the [contributors][contributors] who participated in the development
and to the folks who reported bugs or shared ideas.
2020-01-04 12:05:41 +03:00
Last but not least, thanks to [JetBrains][jetbrains] for providing the _Open Source License_.
2021-01-25 15:19:50 +03:00
## Sponsoring
If you'd like to sponsor this project, the following options are available.
2020-01-04 12:05:41 +03:00
[![Ko-fi](https://img.shields.io/badge/Support_Me_on_Ko--fi-ff5e5b?logo=ko-fi&logoColor=white)][ko-fi]&nbsp;
[![Wechat Pay](https://img.shields.io/badge/Tip_Me_on_WeChat-brightgreen?logo=wechat&logoColor=white)][donation]&nbsp;
[![Alipay](https://img.shields.io/badge/Tip_Me_on_Alipay-blue?logo=alipay&logoColor=white)][donation]
2019-09-30 15:37:14 +03:00
## License
This work 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/
[bootstrap]: https://getbootstrap.com/
[icons]: https://fontawesome.com/
[image]: 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/.github/CONTRIBUTING.md
[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors
[lib]: https://github.com/cotes2020/chirpy-static-assets
[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy
[ko-fi]: https://ko-fi.com/coteschung/
[donation]: https://sponsor.cotes.page/