chirpy-starter/README.md

57 lines
2.2 KiB
Markdown
Raw Permalink Normal View History

# Chirpy Starter
2021-01-26 07:13:40 +10:00
[![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]
2021-02-06 00:42:29 +10:00
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.
2021-01-26 07:13:40 +10:00
The Jekyll team claims that this is to leave the ball in the users 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:
2021-01-26 07:13:40 +10:00
```shell
2021-04-30 16:08:12 +10:00
.
2021-09-26 03:20:50 +10:00
├── _config.yml
├── _plugins
├── _tabs
2021-09-26 03:20:50 +10:00
└── index.html
2021-01-26 07:13:40 +10:00
```
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.
2021-09-26 03:20:50 +10:00
## Prerequisites
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of
the basic environment. [Git](https://git-scm.com/) also needs to be installed.
2021-02-06 00:42:29 +10:00
2021-01-26 07:13:40 +10:00
## Installation
Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it
`USERNAME.github.io`, where `USERNAME` represents your GitHub username.
2021-01-26 07:13:40 +10:00
2021-09-26 03:20:50 +10:00
Then clone it to your local machine and run:
2021-01-26 07:13:40 +10:00
```console
2021-01-26 07:13:40 +10:00
$ bundle
```
## Usage
2022-01-04 20:58:29 +10:00
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
2021-01-26 07:13:40 +10:00
## License
2021-02-11 04:58:14 +10:00
This work is published under [MIT][mit] License.
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
2021-09-26 03:20:50 +10:00
[use-template]: https://github.com/cotes2020/chirpy-starter/generate
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
2021-02-06 00:42:29 +10:00
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE