Skip to content

Commit a406787

Browse files
gregsdennisgregsdennis
authored
Initial commit
0 parents  commit a406787

20 files changed

+521
-0
lines changed

Diff for: ‎.editorconfig

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
trim_trailing_whitespace = true
8+
# Unix-style newlines with a newline ending every file
9+
end_of_line = lf
10+
insert_final_newline = true
11+
12+
[*.{js,css,scss}]
13+
quote_type = single
14+
15+
[*.{yml,yaml}]
16+
quote_type = double
17+
18+
[*.md]
19+
trim_trailing_whitespace = false

Diff for: ‎.gitattributes

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Set default behavior to automatically normalize line endings.
2+
* text=auto
3+
4+
# Force bash scripts to always use LF line endings so that if a repo is accessed
5+
# in Unix via a file share from Windows, the scripts will work.
6+
*.sh text eol=lf
7+
8+
# Force batch scripts to always use CRLF line endings so that if a repo is accessed
9+
# in Windows via a file share from Linux, the scripts will work.
10+
*.{cmd,[cC][mM][dD]} text eol=crlf
11+
*.{bat,[bB][aA][tT]} text eol=crlf
12+
13+
# Denote all files that are truly binary and should not be modified.
14+
*.png binary
15+
*.jpg binary
16+
*.ico binary

Diff for: ‎.github/workflows/pages-deploy.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: "Build and Deploy"
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- master
7+
paths-ignore:
8+
- .gitignore
9+
- README.md
10+
- LICENSE
11+
12+
# Allows you to run this workflow manually from the Actions tab
13+
workflow_dispatch:
14+
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# Allow one concurrent deployment
21+
concurrency:
22+
group: "pages"
23+
cancel-in-progress: true
24+
25+
jobs:
26+
build:
27+
runs-on: ubuntu-latest
28+
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v3
32+
with:
33+
fetch-depth: 0
34+
# submodules: true
35+
# If using the 'assets' git submodule from Chirpy Starter, uncomment above
36+
# (See: https://github.com/cotes2020/chirpy-starter/tree/main/assets)
37+
38+
- name: Setup Pages
39+
id: pages
40+
uses: actions/configure-pages@v3
41+
42+
- name: Setup Ruby
43+
uses: ruby/setup-ruby@v1
44+
with:
45+
ruby-version: 3 # reads from a '.ruby-version' or '.tools-version' file if 'ruby-version' is omitted
46+
bundler-cache: true
47+
48+
- name: Build site
49+
run: bundle exec jekyll b -d "_site${{ steps.pages.outputs.base_path }}"
50+
env:
51+
JEKYLL_ENV: "production"
52+
53+
- name: Test site
54+
run: |
55+
bundle exec htmlproofer _site --disable-external --check-html --allow_hash_href
56+
57+
- name: Upload site artifact
58+
uses: actions/upload-pages-artifact@v1
59+
with:
60+
path: "_site${{ steps.pages.outputs.base_path }}"
61+
62+
deploy:
63+
environment:
64+
name: github-pages
65+
url: ${{ steps.deployment.outputs.page_url }}
66+
runs-on: ubuntu-latest
67+
needs: build
68+
steps:
69+
- name: Deploy to GitHub Pages
70+
id: deployment
71+
uses: actions/deploy-pages@v1

Diff for: ‎.gitignore

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Bundler cache
2+
.bundle
3+
vendor
4+
Gemfile.lock
5+
6+
# Jekyll cache
7+
.jekyll-cache
8+
_site
9+
10+
# RubyGems
11+
*.gem
12+
13+
# NPM dependencies
14+
node_modules
15+
package-lock.json
16+
17+
# IDE configurations
18+
.idea
19+
.vscode
20+
21+
# Misc
22+
assets/js/dist

Diff for: ‎.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "assets/lib"]
2+
path = assets/lib
3+
url = https://github.com/cotes2020/chirpy-static-assets.git

Diff for: ‎.nojekyll

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

Diff for: ‎Gemfile

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
gem "jekyll-theme-chirpy", "~> 5.6", ">= 5.6.1"
6+
7+
group :test do
8+
gem "html-proofer", "~> 3.18"
9+
end
10+
11+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
12+
# and associated library.
13+
platforms :mingw, :x64_mingw, :mswin, :jruby do
14+
gem "tzinfo", ">= 1", "< 3"
15+
gem "tzinfo-data"
16+
end
17+
18+
# Performance-booster for watching directories on Windows
19+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
20+
21+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
22+
# do not have a Java counterpart.
23+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
24+
25+
# Lock jekyll-sass-converter to 2.x on Linux-musl
26+
if RUBY_PLATFORM =~ /linux-musl/
27+
gem "jekyll-sass-converter", "~> 2.0"
28+
end

Diff for: ‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Cotes Chung
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: ‎README.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Chirpy Starter [![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)](https://rubygems.org/gems/jekyll-theme-chirpy) [![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
2+
3+
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.
4+
5+
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.
6+
7+
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:
8+
9+
```shell
10+
.
11+
├── _config.yml
12+
├── _plugins
13+
├── _tabs
14+
└── index.html
15+
```
16+
17+
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.
18+
19+
## Prerequisites
20+
21+
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.
22+
23+
## Installation
24+
25+
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.
26+
27+
Then clone it to your local machine and run:
28+
29+
```
30+
$ bundle
31+
```
32+
33+
## Usage
34+
35+
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
36+
37+
## License
38+
39+
This work is published under [MIT][mit] License.
40+
41+
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
42+
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
43+
[use-template]: https://github.com/cotes2020/chirpy-starter/generate
44+
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
45+
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE

0 commit comments

Comments
 (0)