|
1 | | -# YoungHoney의 개인 블로그입니다. |
| 1 | +# Chirpy Starter |
| 2 | +[][gem] |
| 3 | +[][mit] |
2 | 4 |
|
3 | | -## 블로그 주소로 이동해 주세요. |
4 | | -https://younghoney.github.io/ |
| 5 | +When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders |
| 6 | +`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file |
| 7 | +from the theme's gem. If you have ever installed this theme gem, you can use the command |
| 8 | +`bundle info --path jekyll-theme-chirpy` to locate these files. |
| 9 | + |
| 10 | +The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being |
| 11 | +able to enjoy the out-of-the-box experience when using feature-rich themes. |
| 12 | + |
| 13 | +To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your |
| 14 | +Jekyll site. The following is a list of targets: |
| 15 | + |
| 16 | +```shell |
| 17 | +. |
| 18 | +├── _config.yml |
| 19 | +├── _plugins |
| 20 | +├── _tabs |
| 21 | +└── index.html |
| 22 | +``` |
| 23 | + |
| 24 | +To save you time, and also in case you lose some files while copying, we extract those files/configurations of the |
| 25 | +latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes. |
| 26 | + |
| 27 | +## Prerequisites |
| 28 | + |
| 29 | +Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of |
| 30 | +the basic environment. [Git](https://git-scm.com/) also needs to be installed. |
| 31 | + |
| 32 | +## Installation |
| 33 | + |
| 34 | +Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it |
| 35 | +`USERNAME.github.io`, where `USERNAME` represents your GitHub username. |
| 36 | + |
| 37 | +Then clone it to your local machine and run: |
| 38 | + |
| 39 | +```console |
| 40 | +$ bundle |
| 41 | +``` |
| 42 | + |
| 43 | +## Usage |
| 44 | + |
| 45 | +Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation). |
| 46 | + |
| 47 | +## Contributing |
| 48 | + |
| 49 | +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. |
| 50 | + |
| 51 | +## License |
| 52 | + |
| 53 | +This work is published under [MIT][mit] License. |
| 54 | + |
| 55 | +[gem]: https://rubygems.org/gems/jekyll-theme-chirpy |
| 56 | +[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/ |
| 57 | +[use-template]: https://github.com/cotes2020/chirpy-starter/generate |
| 58 | +[CD]: https://en.wikipedia.org/wiki/Continuous_deployment |
| 59 | +[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE |
0 commit comments