https://github.com/cotes2020/chirpy-starter

A website startup template using the Chirpy theme gem.
https://github.com/cotes2020/chirpy-starter

jekyll-site-starter jekyll-template jekyll-theme-chirpy

Last synced: 3 days ago
JSON representation

A website startup template using the Chirpy theme gem.

• Host: GitHub
• URL: https://github.com/cotes2020/chirpy-starter
• Owner: cotes2020
• License: mit
• Created: 2021-01-25T21:36:59.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T12:05:46.000Z (about 2 months ago)
• Last Synced: 2024-11-06T15:47:55.204Z (10 days ago)
• Topics: jekyll-site-starter, jekyll-template, jekyll-theme-chirpy
• Language: Shell
• Homepage: https://chirpy.cotes.page
• Size: 97.7 KB
• Stars: 599
• Watchers: 18
• Forks: 299
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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