|
1 | | -<!-- markdownlint-disable-next-line --> |
2 | | -<div align="center"> |
| 1 | +# Chirpy Starter |
3 | 2 |
|
4 | | - <!-- markdownlint-disable-next-line --> |
5 | | - # Chirpy Jekyll Theme |
| 3 | +[][gem] |
| 4 | +[][mit] |
6 | 5 |
|
7 | | - A minimal, responsive, and feature-rich Jekyll theme for technical writing. |
| 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. |
8 | 10 |
|
9 | | - [][ci] |
10 | | - [][codacy] |
11 | | - [][license] |
12 | | - [][gem] |
13 | | - [][open-container] |
| 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. |
14 | 13 |
|
15 | | - [**Live Demo** →][demo] |
| 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: |
16 | 16 |
|
17 | | - [][demo] |
| 17 | +```shell |
| 18 | +. |
| 19 | +├── _config.yml |
| 20 | +├── _plugins |
| 21 | +├── _tabs |
| 22 | +└── index.html |
| 23 | +``` |
18 | 24 |
|
19 | | -</div> |
| 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. |
20 | 27 |
|
21 | | -## Features |
| 28 | +## Usage |
22 | 29 |
|
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]. |
| 30 | +Check out the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). |
45 | 31 |
|
46 | 32 | ## Contributing |
47 | 33 |
|
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 | | -[][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]. |
| 34 | +This repository is automatically updated with new releases from the theme repository. If you encounter any issues or want to contribute to its improvement, please visit the [theme repository][chirpy] to provide feedback. |
66 | 35 |
|
67 | 36 | ## License |
68 | 37 |
|
69 | | -This project is published under [MIT License][license]. |
| 38 | +This work is published under [MIT][mit] License. |
70 | 39 |
|
71 | 40 | [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 |
| 41 | +[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/ |
| 42 | +[CD]: https://en.wikipedia.org/wiki/Continuous_deployment |
| 43 | +[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE |
0 commit comments