|
1 |
| -# Chirpy Starter |
| 1 | +<div align="center"> |
2 | 2 |
|
3 |
| -[][gem] |
4 |
| -[][mit] |
| 3 | + # Chirpy Jekyll Theme |
5 | 4 |
|
6 |
| -When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders |
7 |
| -`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file |
8 |
| -from the theme's gem. If you have ever installed this theme gem, you can use the command |
9 |
| -`bundle info --path jekyll-theme-chirpy` to locate these files. |
| 5 | + A minimal, responsive, and feature-rich Jekyll theme for technical writing. |
10 | 6 |
|
11 |
| -The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being |
12 |
| -able to enjoy the out-of-the-box experience when using feature-rich themes. |
| 7 | + [][gem] |
| 8 | + [][ci] |
| 9 | + [][codacy] |
| 10 | + [][license] |
| 11 | + [](https://996.icu) |
13 | 12 |
|
14 |
| -To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your |
15 |
| -Jekyll site. The following is a list of targets: |
| 13 | + [**Live Demo** →][demo] |
16 | 14 |
|
17 |
| -```shell |
18 |
| -. |
19 |
| -├── _config.yml |
20 |
| -├── _plugins |
21 |
| -├── _tabs |
22 |
| -└── index.html |
23 |
| -``` |
| 15 | + [][demo] |
24 | 16 |
|
25 |
| -To save you time, and also in case you lose some files while copying, we extract those files/configurations of the |
26 |
| -latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes. |
| 17 | +</div> |
27 | 18 |
|
28 |
| -## Prerequisites |
| 19 | +## Features |
29 | 20 |
|
30 |
| -Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of |
31 |
| -the basic environment. [Git](https://git-scm.com/) also needs to be installed. |
| 21 | +- Dark / Light Theme Mode |
| 22 | +- Localized UI language |
| 23 | +- Pinned Posts on Home Page |
| 24 | +- Hierarchical Categories |
| 25 | +- Trending Tags |
| 26 | +- Table of Contents |
| 27 | +- Last Modified Date |
| 28 | +- Syntax Highlighting |
| 29 | +- Mathematical Expressions |
| 30 | +- Mermaid Diagrams & Flowcharts |
| 31 | +- Dark / Light Mode Images |
| 32 | +- Embed Videos |
| 33 | +- Disqus / Giscus / Utterances Comments |
| 34 | +- Built-in Search |
| 35 | +- Atom Feeds |
| 36 | +- PWA |
| 37 | +- Google Analytics / GoatCounter |
| 38 | +- SEO & Performance Optimization |
32 | 39 |
|
33 |
| -## Installation |
| 40 | +## Documentation |
34 | 41 |
|
35 |
| -Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it |
36 |
| -`USERNAME.github.io`, where `USERNAME` represents your GitHub username. |
| 42 | +To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki]. |
37 | 43 |
|
38 |
| -Then clone it to your local machine and run: |
| 44 | +## Contributing |
39 | 45 |
|
40 |
| -```console |
41 |
| -$ bundle |
42 |
| -``` |
| 46 | +Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place |
| 47 | +to learn, inspire, and create. Any contributions you make are greatly appreciated. |
| 48 | +For details, see the "[Contributing Guidelines][contribute-guide]". |
43 | 49 |
|
44 |
| -## Usage |
| 50 | +## Credits |
45 | 51 |
|
46 |
| -Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation). |
| 52 | +### Contributors |
| 53 | + |
| 54 | +Thanks to [all the contributors][contributors] involved in the development of the project! |
| 55 | + |
| 56 | +[][contributors] |
| 57 | +<sub> —— Made with [contrib.rocks](https://contrib.rocks)</sub> |
| 58 | + |
| 59 | +### Third-Party Assets |
| 60 | + |
| 61 | +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. |
| 62 | + |
| 63 | +The avatar and favicon for the project's website are from [ClipartMAX][clipartmax]. |
47 | 64 |
|
48 | 65 | ## License
|
49 | 66 |
|
50 |
| -This work is published under [MIT][mit] License. |
| 67 | +This project is published under [MIT License][license]. |
51 | 68 |
|
52 | 69 | [gem]: https://rubygems.org/gems/jekyll-theme-chirpy
|
53 |
| -[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/ |
54 |
| -[use-template]: https://github.com/cotes2020/chirpy-starter/generate |
55 |
| -[CD]: https://en.wikipedia.org/wiki/Continuous_deployment |
56 |
| -[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE |
| 70 | +[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster |
| 71 | +[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade |
| 72 | +[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE |
| 73 | +[jekyllrb]: https://jekyllrb.com/ |
| 74 | +[clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/ |
| 75 | +[demo]: https://cotes2020.github.io/chirpy-demo/ |
| 76 | +[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki |
| 77 | +[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md |
| 78 | +[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors |
| 79 | +[lib]: https://github.com/cotes2020/chirpy-static-assets |
| 80 | +[vscode]: https://code.visualstudio.com/ |
| 81 | +[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy |
0 commit comments