Skip to content

Commit

Permalink
Merge branch 'main' into fix-youtube-scraping
Browse files Browse the repository at this point in the history
  • Loading branch information
mattpopovich committed Mar 4, 2024
2 parents 89fa8aa + b960cf9 commit db829cc
Show file tree
Hide file tree
Showing 103 changed files with 747 additions and 1,667 deletions.
3 changes: 2 additions & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
"shardulm94.trailing-spaces",
"yzhang.markdown-all-in-one",
"eamodio.gitlens",
"github.vscode-github-actions"
"github.vscode-github-actions",
"streetsidesoftware.code-spell-checker"
]
}
}
Expand Down
9 changes: 7 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true

[*.{js,css,scss}]
quote_type = single

[*.js]
indent_size = 4
[*.{yml,yaml}]
quote_type = double

[*.md]
trim_trailing_whitespace = false
24 changes: 4 additions & 20 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,13 @@ jobs:
steps:
# Pull our repository
- name: Checkout
uses: actions/checkout@v3
# with:
# fetch-depth: 0
uses: actions/checkout@v4
with:
fetch-depth: 0 # for posts's lastmod
# submodules: true
# If using the 'assets' git submodule from Chirpy Starter, uncomment above
# (See: https://github.com/cotes2020/chirpy-starter/tree/main/assets)

- name: Debug
# confirmed that rsync is installed
run: |
echo "Debugging..."
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
Expand All @@ -38,24 +33,13 @@ jobs:

- name: Build site
run: |
pwd
ls -lah
bundle exec jekyll b
ls -lah
ls -lah _site
env:
JEKYLL_ENV: "production"

- name: Test site
run: |
ls -alh
ls -lah _site
bundle exec htmlproofer _site --disable-external --check-html --allow_hash_href
- name: Upload site artifact
uses: actions/upload-pages-artifact@v1
with:
path: "_site"
bundle exec htmlproofer _site --disable-external --check-html --ignore-urls http://www.mathmatique.com/articles/left-exercise-reader
- name: Dry-run deployment to mattpopovich.com
uses: easingthemes/[email protected]
Expand Down
15 changes: 3 additions & 12 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v3
# with:
# fetch-depth: 0
uses: actions/checkout@v4
with:
fetch-depth: 0 # for posts's lastmod
# submodules: true
# If using the 'assets' git submodule from Chirpy Starter, uncomment above
# (See: https://github.com/cotes2020/chirpy-starter/tree/main/assets)
Expand All @@ -43,19 +43,10 @@ jobs:

- name: Build site
run: |
pwd
ls -lah
bundle exec jekyll b
ls -lah
ls -lah _site
env:
JEKYLL_ENV: "production"

# - name: Upload site artifact
# uses: actions/upload-pages-artifact@v1
# with:
# path: "_site"

- name: Deploy to mattpopovich.com
uses: easingthemes/[email protected]
env:
Expand Down
32 changes: 19 additions & 13 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# hidden files
.*
!.git*
!.editorconfig
!.nojekyll
!.husky
!.commitlintrc.json
!.versionrc.json
!.stylelintrc.json
# Bundler cache
.bundle
vendor
Gemfile.lock

# bundler cache
# Jekyll cache
.jekyll-cache
_site
vendor

# rubygem
# RubyGems
*.gem

# npm dependencies
# NPM dependencies
node_modules
package-lock.json

# IDE configurations
.idea
.vscode

# Misc
assets/js/dist

# OSX
.DS_Store

3 changes: 0 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
[submodule "assets/lib"]
path = assets/lib
url = https://github.com/cotes2020/chirpy-static-assets.git
4 changes: 4 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ RUN apt-get update && apt-get install -y \

# For pulling data from YouTube's API in tools/make-new-post.py
RUN pip3 install google-auth-oauthlib google-api-python-client

# Required to run `bundle exec htmlproofer`
RUN apt-get update && apt-get install -y \
libcurl4-gnutls-dev
17 changes: 8 additions & 9 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,22 @@

source "https://rubygems.org"

gem "jekyll-theme-chirpy", "~> 5.4", ">= 5.4.0"
gem "jekyll-theme-chirpy", "~> 6.3", ">= 6.3.1"

group :test do
gem "html-proofer", "~> 3.18"
gem "html-proofer", "~> 4.4"
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
gem "tzinfo", "~> 1.2"
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

# Lock jekyll-sass-converter to 2.x on Linux-musl
if RUBY_PLATFORM =~ /linux-musl/
gem "jekyll-sass-converter", "~> 2.0"
end
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
68 changes: 36 additions & 32 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.1)
addressable (2.8.5)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.1.10)
concurrent-ruby (1.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.16.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
ffi (1.15.5)
ffi (1.16.3)
forwardable-extended (2.6.0)
html-proofer (3.19.4)
google-protobuf (3.25.1-aarch64-linux)
google-protobuf (3.25.1-x86_64-linux)
html-proofer (4.4.3)
addressable (~> 2.3)
mercenary (~> 0.3)
nokogiri (~> 1.13)
parallel (~> 1.10)
rainbow (~> 3.0)
typhoeus (~> 1.3)
yell (~> 2.0)
zeitwerk (~> 2.5)
http_parser.rb (0.8.0)
i18n (1.12.0)
i18n (1.14.1)
concurrent-ruby (~> 1.0)
jekyll (4.3.1)
jekyll (4.3.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
Expand All @@ -42,73 +45,74 @@ GEM
webrick (~> 1.7)
jekyll-archives (2.2.1)
jekyll (>= 3.6, < 5.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.16.0)
jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-theme-chirpy (5.4.0)
jekyll-theme-chirpy (6.3.1)
jekyll (~> 4.3)
jekyll-archives (~> 2.2)
jekyll-include-cache (~> 0.2)
jekyll-paginate (~> 1.1)
jekyll-redirect-from (~> 0.16)
jekyll-seo-tag (~> 2.7)
jekyll-seo-tag (~> 2.8)
jekyll-sitemap (~> 1.4)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
liquid (4.0.4)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
nokogiri (1.13.10-aarch64-linux)
nokogiri (1.15.5-aarch64-linux)
racc (~> 1.4)
nokogiri (1.13.10-x86_64-linux)
nokogiri (1.15.5-x86_64-linux)
racc (~> 1.4)
parallel (1.22.1)
parallel (1.23.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.1)
racc (1.6.2)
public_suffix (5.0.4)
racc (1.7.3)
rainbow (3.1.1)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (4.0.1)
rexml (3.2.6)
rouge (4.2.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
sass-embedded (1.69.5-aarch64-linux-gnu)
google-protobuf (~> 3.23)
sass-embedded (1.69.5-x86_64-linux-gnu)
google-protobuf (~> 3.23)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
thread_safe (0.3.6)
typhoeus (1.4.0)
typhoeus (1.4.1)
ethon (>= 0.9.0)
tzinfo (1.2.10)
thread_safe (~> 0.1)
tzinfo-data (1.2022.7)
tzinfo (>= 1.0.0)
unicode-display_width (2.4.2)
wdm (0.1.1)
webrick (1.7.0)
unicode-display_width (2.5.0)
webrick (1.8.1)
yell (2.2.2)
zeitwerk (2.6.12)

PLATFORMS
aarch64-linux
x86_64-linux

DEPENDENCIES
html-proofer (~> 3.18)
jekyll-theme-chirpy (~> 5.4, >= 5.4.0)
tzinfo (~> 1.2)
html-proofer (~> 4.4)
http_parser.rb (~> 0.6.0)
jekyll-theme-chirpy (~> 6.3, >= 6.3.1)
tzinfo (>= 1, < 3)
tzinfo-data
wdm (~> 0.1.1)

Expand Down
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,43 @@
# 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]
# Chirpy Starter

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.
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem]&nbsp;
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]

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.
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.

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:
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
├── _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.
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.

## Prerequisites

Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll` and `Bundler`.
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.

## Installation

[**Use this template**][use-template] to generate a brand new repository and name it `<GH_USERNAME>.github.io`, where `GH_USERNAME` represents your GitHub username.
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.

Then clone it to your local machine and run:

```
```console
$ bundle
```

Expand Down
Loading

0 comments on commit db829cc

Please sign in to comment.