generated from cotes2020/chirpy-starter
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
15 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,3 @@ | ||
# Chirpy Starter | ||
|
||
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem] | ||
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit] | ||
|
||
When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders | ||
`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file | ||
from the theme's gem. If you have ever installed this theme gem, you can use the command | ||
`bundle info --path jekyll-theme-chirpy` to locate these files. | ||
|
||
The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being | ||
able to enjoy the out-of-the-box experience when using feature-rich themes. | ||
|
||
To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your | ||
Jekyll site. The following is a list of targets: | ||
|
||
```shell | ||
. | ||
├── _config.yml | ||
├── _plugins | ||
├── _tabs | ||
└── index.html | ||
``` | ||
|
||
To save you time, and also in case you lose some files while copying, we extract those files/configurations of the | ||
latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes. | ||
|
||
## Usage | ||
|
||
Check out the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). | ||
|
||
## Contributing | ||
|
||
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. | ||
|
||
## License | ||
|
||
This work is published under [MIT][mit] License. | ||
|
||
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy | ||
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/ | ||
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment | ||
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE | ||
Hi there~👏 | ||
* ☺︎IC Master’s student at FDU | ||
* ☼ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.