|
1 | | -# Chirpy Starter |
| 1 | +# logicallaw.github.io |
2 | 2 |
|
3 | | -[][gem] |
4 | | -[][mit] |
| 3 | +## Build and Run |
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. |
10 | | - |
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. |
13 | | - |
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 | | - |
17 | | -```shell |
18 | | -. |
19 | | -├── _config.yml |
20 | | -├── _plugins |
21 | | -├── _tabs |
22 | | -└── index.html |
23 | 5 | ``` |
24 | | - |
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. |
27 | | - |
28 | | -## Usage |
29 | | - |
30 | | -Check out the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). |
31 | | - |
32 | | -## Contributing |
33 | | - |
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. |
35 | | - |
36 | | -## License |
37 | | - |
38 | | -This work is published under [MIT][mit] License. |
39 | | - |
40 | | -[gem]: https://rubygems.org/gems/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 |
44 | | - |
45 | | -How to build in local? |
46 | | - |
47 | | - |
| 6 | +bundle exec jekyll serve |
| 7 | +``` |
0 commit comments