Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cole-maxwell1/cole-maxwell1.github.io
Cole's blog/about site
https://github.com/cole-maxwell1/cole-maxwell1.github.io
blog ci-cd jekyll jekyll-blog jekyll-theme
Last synced: about 2 months ago
JSON representation
Cole's blog/about site
- Host: GitHub
- URL: https://github.com/cole-maxwell1/cole-maxwell1.github.io
- Owner: cole-maxwell1
- License: mit
- Created: 2022-08-02T00:27:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T20:03:57.000Z (8 months ago)
- Last Synced: 2024-11-01T18:39:06.768Z (2 months ago)
- Topics: blog, ci-cd, jekyll, jekyll-blog, jekyll-theme
- Language: Shell
- Homepage: https://colemaxwell.dev/
- Size: 574 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# About
This is my personal blog/about site where I post random things about cool tech I am playing with. The project was inspired by a video that @timothystewart6 did on [youtube](https://youtu.be/F8iOU1ci19Q). It is built with the Ruby static site generator [Jekyll](https://jekyllrb.com/). Hosting is provided by GitHub pages.
Some of the main drivers that lead me to move away from WordPress are:
* I feel writing in markdown is both more convenient and better for technical topics
* Markdown is more portable when I inevitably decide to move my blog again
* I never have to leave my text editor to add new posts or update other parts of the site
* While hosting fees for my WordPress instants were very low, it is nice to host on a free service and eliminate the cost
The heavy lifting for the CI/CD GitHub actions, and Jekyll theme were provided by @cotes2020. More information about the theme below:
# 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
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
## 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