Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anilbey/anilbey.github.io
https://github.com/anilbey/anilbey.github.io
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/anilbey/anilbey.github.io
- Owner: anilbey
- License: mit
- Created: 2022-12-28T23:00:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T12:07:10.000Z (about 1 month ago)
- Last Synced: 2024-10-19T16:15:46.935Z (29 days ago)
- Language: Ruby
- Size: 3.64 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chirpy Starter [](https://rubygems.org/gems/jekyll-theme-chirpy) [][mit]
When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders `_includes`, `_layout`, `_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 organization 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
├── _data
├── _plugins
├── _tabs
└── index.html
```
In order to save your time, and to prevent you from missing some files when 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.
## Prerequisites
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
## Installation
[**Use this template**][use-template] to generate a brand new repository and name it `.github.io`, where `GH_USERNAME` represents your GitHub username.
Then clone it to your local machine and run:
```
$ bundle
```
## Usage
Use the following command to start the Jekyll server:
```
$ bundle exec jekyll serve
```
Then open your browser and visit `http://localhost:4000/` to preview your site.
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation) for more information.
## 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/
[use-template]: https://github.com/cotes2020/chirpy-starter/generate
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE