mirror of
https://github.com/cotes2020/chirpy-starter.git
synced 2026-06-07 03:37:57 +00:00
40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
# Chirpy Starter
|
|
|
|
[][gem]
|
|
[][mit]
|
|
|
|
A minimal, ready-to-use template for creating a blog with the [**Chirpy**][chirpy] Jekyll theme. Get up and running in minutes with all critical files pre-configured.
|
|
|
|
## Why This Starter Exists
|
|
|
|
When installing Chirpy through [RubyGems.org][gem], Jekyll can only read a subset of theme files (`_data`, `_layouts`, `_includes`, `_sass`, `assets`) and limited `_config.yml` options from the gem. As a result, users cannot enjoy the full out-of-the-box experience that Chirpy offers.
|
|
|
|
To unlock all features, the following files must be present in your Jekyll site:
|
|
|
|
```shell
|
|
.
|
|
├── _config.yml
|
|
├── _plugins
|
|
├── _tabs
|
|
└── index.html
|
|
```
|
|
|
|
This starter bundles those files from the latest **Chirpy** release along with a [CD][CD] workflow, so you can start writing immediately.
|
|
|
|
## 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
|