Skip to content

Commit 755e8fb

Browse files
authored
feat: migrated to jekyll-based site (#32)
* feat: started working on jekyll integration * fix: fixed a bunch of jekyll stuff, moved out of temporary jekyll/ folder * ci: fix Makefile & CI for new jekyll-based site * build(deps): ran `bundle lock --add-platform x86_64-linux` * fix: added uncommited html files, fixed css link * fix: added & setup jekyll-seo-tag, fixed title, removed minima theme dependency
1 parent 304ada7 commit 755e8fb

27 files changed

+697
-6416
lines changed

.github/workflows/pages.yml

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,11 @@ on:
1111

1212
jobs:
1313
build-and-deploy:
14-
name: Build and deploy (py-${{ matrix.python_version }}, ruby-${{ matrix.ruby_version }})
14+
name: Build and deploy (ruby-${{ matrix.ruby_version }})
1515
runs-on: ubuntu-latest
1616
strategy:
1717
matrix:
18-
ruby_version: ['2.7']
19-
python_version: ['3.9']
18+
ruby_version: ['3.2']
2019
steps:
2120
- name: Checkout 🛎️
2221
uses: actions/checkout@v2
@@ -27,23 +26,18 @@ jobs:
2726
with:
2827
ruby-version: ${{ matrix.ruby_version }}
2928
bundler-cache: true
30-
- name: Setup Python
31-
uses: actions/setup-python@v1
32-
with:
33-
python-version: ${{ matrix.python_version }}
3429
- name: Install dependencies
3530
run: |
3631
make install
3732
sudo npm install --global pug pug-cli
3833
- name: Build
3934
run: |
4035
make build
41-
touch build-superuser/.nojekyll
4236
- name: Deploy 🚀
4337
uses: JamesIves/[email protected]
4438
if: github.ref == 'refs/heads/master'
4539
with:
4640
branch: gh-pages # The branch the action should deploy to.
47-
folder: build-superuser # The folder the action should deploy.
41+
folder: _site # The folder the action should deploy.
4842
git-config-name: GitHub Actions
4943
git-config-email: [email protected]

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ node_modules
55
.*cache
66

77
# built files
8-
*.html
98
*.css
109
*.css.map
1110
build*
11+
12+
# jekyll
13+
_site
14+
.sass-cache
15+
.jekyll-cache
16+
.jekyll-metadata
17+
vendor

404.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: default
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

Gemfile

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 4.3.2"
11+
12+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
13+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
14+
# gem "github-pages", group: :jekyll_plugins
15+
# If you have any plugins, put them here!
16+
group :jekyll_plugins do
17+
gem "jekyll-feed", "~> 0.12"
18+
gem 'jekyll-last-modified-at'
19+
gem "jekyll-redirect-from", "~> 0.16.0"
20+
gem 'jekyll-pug'
21+
gem 'jekyll-sitemap'
22+
gem 'jekyll-compose'
23+
gem 'jekyll-toc'
24+
gem 'jekyll-seo-tag'
25+
end
26+
27+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
28+
# and associated library.
29+
platforms :mingw, :x64_mingw, :mswin, :jruby do
30+
gem "tzinfo", ">= 1", "< 3"
31+
gem "tzinfo-data"
32+
end
33+
34+
# Performance-booster for watching directories on Windows
35+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
36+
37+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
38+
# do not have a Java counterpart.
39+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

Gemfile.lock

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.5)
5+
public_suffix (>= 2.0.2, < 6.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.2.2)
8+
em-websocket (0.5.3)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0)
11+
eventmachine (1.2.7)
12+
execjs (2.9.1)
13+
ffi (1.16.3)
14+
forwardable-extended (2.6.0)
15+
google-protobuf (3.25.0-arm64-darwin)
16+
google-protobuf (3.25.0-x86_64-linux)
17+
http_parser.rb (0.8.0)
18+
i18n (1.14.1)
19+
concurrent-ruby (~> 1.0)
20+
jekyll (4.3.2)
21+
addressable (~> 2.4)
22+
colorator (~> 1.0)
23+
em-websocket (~> 0.5)
24+
i18n (~> 1.0)
25+
jekyll-sass-converter (>= 2.0, < 4.0)
26+
jekyll-watch (~> 2.0)
27+
kramdown (~> 2.3, >= 2.3.1)
28+
kramdown-parser-gfm (~> 1.0)
29+
liquid (~> 4.0)
30+
mercenary (>= 0.3.6, < 0.5)
31+
pathutil (~> 0.9)
32+
rouge (>= 3.0, < 5.0)
33+
safe_yaml (~> 1.0)
34+
terminal-table (>= 1.8, < 4.0)
35+
webrick (~> 1.7)
36+
jekyll-compose (0.12.0)
37+
jekyll (>= 3.7, < 5.0)
38+
jekyll-feed (0.17.0)
39+
jekyll (>= 3.7, < 5.0)
40+
jekyll-last-modified-at (1.3.0)
41+
jekyll (>= 3.7, < 5.0)
42+
posix-spawn (~> 0.3.9)
43+
jekyll-pug (1.6.1)
44+
jekyll (>= 3.6, < 5.0)
45+
pug-ruby (~> 2.0)
46+
jekyll-redirect-from (0.16.0)
47+
jekyll (>= 3.3, < 5.0)
48+
jekyll-sass-converter (3.0.0)
49+
sass-embedded (~> 1.54)
50+
jekyll-seo-tag (2.8.0)
51+
jekyll (>= 3.8, < 5.0)
52+
jekyll-sitemap (1.4.0)
53+
jekyll (>= 3.7, < 5.0)
54+
jekyll-toc (0.18.0)
55+
jekyll (>= 3.9)
56+
nokogiri (~> 1.12)
57+
jekyll-watch (2.2.1)
58+
listen (~> 3.0)
59+
kramdown (2.4.0)
60+
rexml
61+
kramdown-parser-gfm (1.1.0)
62+
kramdown (~> 2.0)
63+
liquid (4.0.4)
64+
listen (3.8.0)
65+
rb-fsevent (~> 0.10, >= 0.10.3)
66+
rb-inotify (~> 0.9, >= 0.9.10)
67+
memoist (0.16.2)
68+
mercenary (0.4.0)
69+
method-not-implemented (1.0.1)
70+
nokogiri (1.15.4-arm64-darwin)
71+
racc (~> 1.4)
72+
nokogiri (1.15.4-x86_64-linux)
73+
racc (~> 1.4)
74+
pathutil (0.16.2)
75+
forwardable-extended (~> 2.6)
76+
posix-spawn (0.3.15)
77+
public_suffix (5.0.3)
78+
pug-ruby (2.0.1)
79+
execjs (~> 2.0)
80+
memoist (~> 0.15)
81+
method-not-implemented (~> 1.0, >= 1.0.1)
82+
regexp-match-polyfill (~> 1.0, >= 1.0.2)
83+
racc (1.7.3)
84+
rb-fsevent (0.11.2)
85+
rb-inotify (0.10.1)
86+
ffi (~> 1.0)
87+
regexp-match-polyfill (1.0.2)
88+
rexml (3.2.6)
89+
rouge (4.2.0)
90+
safe_yaml (1.0.5)
91+
sass-embedded (1.69.5-arm64-darwin)
92+
google-protobuf (~> 3.23)
93+
sass-embedded (1.69.5-x86_64-linux-gnu)
94+
google-protobuf (~> 3.23)
95+
terminal-table (3.0.2)
96+
unicode-display_width (>= 1.1.1, < 3)
97+
unicode-display_width (2.5.0)
98+
webrick (1.8.1)
99+
100+
PLATFORMS
101+
arm64-darwin-21
102+
x86_64-linux
103+
104+
DEPENDENCIES
105+
http_parser.rb (~> 0.6.0)
106+
jekyll (~> 4.3.2)
107+
jekyll-compose
108+
jekyll-feed (~> 0.12)
109+
jekyll-last-modified-at
110+
jekyll-pug
111+
jekyll-redirect-from (~> 0.16.0)
112+
jekyll-seo-tag
113+
jekyll-sitemap
114+
jekyll-toc
115+
tzinfo (>= 1, < 3)
116+
tzinfo-data
117+
wdm (~> 0.1.1)
118+
119+
BUNDLED WITH
120+
2.4.10

Makefile

Lines changed: 5 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,9 @@
1-
.PHONY: install build build-dev build-superuser build-thankful dev-pug dev-scss host
2-
3-
PUG_OPTS= -O pugopts.js
4-
51
install:
6-
npm install
7-
8-
build: build-superuser build-thankful
9-
10-
build-superuser:
11-
$(eval DEST := "build-superuser")
12-
npm run pug -- -o ${DEST} $(PUG_OPTS) index.pug
13-
npm run pug -- -o ${DEST}/thankful $(PUG_OPTS) thankful
14-
npm run sass -- scss/index.scss ${DEST}/index.css
15-
cp -r media ${DEST}/
16-
17-
build-thankful:
18-
$(eval DEST := "build-thankful")
19-
mkdir -p ${DEST}
20-
#echo "getthankful.io" > ${DEST}/CNAME
21-
npm run pug -- -o ${DEST} $(PUG_OPTS) thankful
22-
npm run sass -- scss/index.scss ${DEST}/index.css
23-
cp -r media ${DEST}/
24-
25-
build-dev:
26-
$(eval DEST := "build-dev")
27-
DEV=true npm run pug -- -o ${DEST} $(PUG_OPTS) index.pug
28-
DEV=true npm run pug -- -o ${DEST}/thankful $(PUG_OPTS) thankful
29-
npm run sass -- scss/index.scss ${DEST}/index.css
30-
cp -r media ${DEST}/
31-
32-
dev-pug-superuser:
33-
DEV=true npm run pug -- -o build-dev --watch $(PUG_OPTS) index.pug
34-
35-
dev-pug-thankful:
36-
DEV=true npm run pug -- -o build-dev/thankful --watch $(PUG_OPTS) thankful/index.pug
37-
38-
dev-scss:
39-
npm run sass -- --watch scss --output build-dev
2+
bundle install
403

414
serve:
42-
mkdir -p build-dev
43-
cp -r media build-dev/
44-
cd build-dev && python -m http.server 8123
5+
bundle exec jekyll serve
456

46-
clean:
47-
rm -rf build
48-
rm -rf build-dev
49-
rm -rf build-superuser
50-
rm -rf build-thankful
7+
build:
8+
bundle exec jekyll build
9+
touch _site/.nojekyll

_config.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole blog, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
10+
#
11+
# If you need help with YAML syntax, here are some quick references for you:
12+
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
13+
# https://learnxinyminutes.com/docs/yaml/
14+
#
15+
# Site settings
16+
# These are used to personalize your new site. If you look in the HTML files,
17+
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
18+
# You can create any custom variable you would like, and they will be accessible
19+
# in the templates via {{ site.myvariable }}.
20+
21+
title: Superuser Labs
22+
23+
description: >- # this means to ignore newlines until "baseurl:"
24+
Superuser Labs is a team of developers and researchers who are passionate about free and open-source software,
25+
and we are building such software to empower users (like you!).
26+
baseurl: "" # the subpath of your site, e.g. /blog
27+
url: "https://superuserlabs.org" # the base hostname & protocol for your site, e.g. http://example.com
28+
twitter_username: SuperusrLabs
29+
github_username: SuperuserLabs
30+
linkedin_company: superuser-labs
31+
32+
# Build settings
33+
#theme: minima
34+
plugins:
35+
- jekyll-feed
36+
- jekyll-pug
37+
- jekyll-sitemap
38+
- jekyll-toc
39+
- jekyll-last-modified-at
40+
- jekyll-redirect-from
41+
- jekyll-seo-tag
42+
43+
collections:
44+
posts:
45+
output: true
46+
permalink: /blog/:title/
47+
48+
# jekyll-seo-tag config
49+
twitter:
50+
username: SuperusrLabs
51+
card: summary
52+
53+
# Exclude from processing.
54+
# The following items will not be processed, by default.
55+
# Any item listed under the `exclude:` key here will be automatically added to
56+
# the internal "default list".
57+
#
58+
# Excluded items can be processed by explicitly listing the directories or
59+
# their entries' file path in the `include:` list.
60+
#
61+
# exclude:
62+
# - .sass-cache/
63+
# - .jekyll-cache/
64+
# - gemfiles/
65+
# - Gemfile
66+
# - Gemfile.lock
67+
# - node_modules/
68+
# - vendor/bundle/
69+
# - vendor/cache/
70+
# - vendor/gems/
71+
# - vendor/ruby/
File renamed without changes.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
meta(charset="utf-8")
22
meta(name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no")
33

4-
// Favicon
5-
link(rel="shortcut icon" href="/media/favicon.ico" type="image/x-icon")
6-
74
// Tailwind
85
script(src="https://cdn.tailwindcss.com")
96
|<script>
@@ -25,8 +22,11 @@ script(src="https://cdn.tailwindcss.com")
2522
link(rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous")
2623

2724
// Custom CSS
28-
link(rel="stylesheet" href="/index.css")
25+
link(rel="stylesheet" href="/style.css")
2926

3027
// Fonts (Roboto & Varela Round)
3128
link(rel="stylesheet" href="http://fonts.googleapis.com/css?family=Roboto:300,400,500,700" type="text/css")
3229
link(rel="stylesheet" href="http://fonts.googleapis.com/css?family=Varela+Round" type="text/css")
30+
31+
// jekyll-seo-tag
32+
| {% seo %}

0 commit comments

Comments
 (0)