Skip to content

Commit dd85eec

Browse files
authored
Merge branch 'cotes2020:master' into nb
2 parents a76ef3d + 4d6c788 commit dd85eec

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!-- markdownlint-disable-next-line -->
2+
<div align="center">
3+
4+
<!-- markdownlint-disable-next-line -->
5+
# Chirpy Jekyll Theme
6+
7+
A minimal, responsive, and feature-rich Jekyll theme for technical writing.
8+
9+
[![CI](https://img.shields.io/github/actions/workflow/status/cotes2020/jekyll-theme-chirpy/ci.yml?logo=github)][ci]&nbsp;
10+
[![Codacy Badge](https://img.shields.io/codacy/grade/4e556876a3c54d5e8f2d2857c4f43894?logo=codacy)][codacy]&nbsp;
11+
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy?color=goldenrod)][license]&nbsp;
12+
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?&logo=RubyGems&logoColor=ghostwhite&label=gem&color=orange)][gem]&nbsp;
13+
[![Open in Dev Containers](https://img.shields.io/badge/Dev_Containers-Open-deepskyblue?logo=linuxcontainers)][open-container]
14+
15+
[**Live Demo**][demo]
16+
17+
[![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]
18+
19+
</div>
20+
21+
## Features
22+
23+
- Dark Theme
24+
- Localized UI language
25+
- Pinned Posts on Home Page
26+
- Hierarchical Categories
27+
- Trending Tags
28+
- Table of Contents
29+
- Last Modified Date
30+
- Syntax Highlighting
31+
- Mathematical Expressions
32+
- Mermaid Diagrams & Flowcharts
33+
- Dark Mode Images
34+
- Embed Media
35+
- Comment Systems
36+
- Built-in Search
37+
- Atom Feeds
38+
- PWA
39+
- Web Analytics
40+
- SEO & Performance Optimization
41+
42+
## Documentation
43+
44+
To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki].
45+
46+
## Contributing
47+
48+
Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place
49+
to learn, inspire, and create. Any contributions you make are greatly appreciated.
50+
For details, see the "[Contributing Guidelines][contribute-guide]".
51+
52+
## Credits
53+
54+
### Contributors
55+
56+
Thanks to [all the contributors][contributors] involved in the development of the project!
57+
58+
[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors]
59+
<sub> — Made with [contrib.rocks](https://contrib.rocks)</sub>
60+
61+
### Third-Party Assets
62+
63+
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.
64+
65+
The avatar and favicon for the project's website are from [ClipartMAX][clipartmax].
66+
67+
## License
68+
69+
This project is published under [MIT License][license].
70+
71+
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
72+
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster
73+
[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
74+
[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE
75+
[open-container]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/cotes2020/jekyll-theme-chirpy
76+
[jekyllrb]: https://jekyllrb.com/
77+
[clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/
78+
[demo]: https://cotes2020.github.io/chirpy-demo/
79+
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
80+
[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md
81+
[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors
82+
[lib]: https://github.com/cotes2020/chirpy-static-assets
83+
[vscode]: https://code.visualstudio.com/
84+
[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy

0 commit comments

Comments
 (0)