Skip to content

Commit c9ff0bc

Browse files
iasonliuiasonliu
authored
Merge pull request #5 from 42devops/feat/modern-theme-neat-annotations
feat: update theme design and integrate neat-annotations
2 parents 4055da0 + 053c80f commit c9ff0bc

11 files changed

Lines changed: 1460 additions & 428 deletions

File tree

‎AGENTS.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# AGENTS.md
2+
3+
## What this is
4+
5+
Jekyll blog for [42devops.com](https://42devops.com), hosted on GitHub Pages. Custom domain configured via `CNAME`. Modern, sleek theme design featuring hand-drawn inline annotations powered by `neat-annotations`.
6+
7+
## Structure
8+
9+
- `_posts/` - Markdown posts, filename format: `YYYY-MM-DD-slug.md` (or `.markdown`)
10+
- `_layouts/` - `default.html`, `post.html`
11+
- `_plugins/` - Local Jekyll build compatibility helpers (`ruby3_compat.rb`)
12+
- `css/` - Static assets (`screen.css`, `syntax.css`, `neat-annotations.css`)
13+
- `js/` - Static scripts
14+
- `images/` - Site images
15+
- `random/` - Misc experiments
16+
17+
## Local dev
18+
19+
```bash
20+
bundle install
21+
RUBYOPT="-r./_plugins/ruby3_compat.rb" bundle exec jekyll serve
22+
```
23+
24+
No `_config.yml` present. GitHub Pages uses defaults. Posts use YAML front matter with `layout`, `title`, `date`, `categories`, `comments`.
25+
26+
## Annotations Usage (`neat-annotations`)
27+
28+
In Markdown posts, use inline annotations with direction and color classes:
29+
30+
```html
31+
<span class="ann ann-n ann-amber" data-note="Handwritten label">Target text</span>
32+
```
33+
34+
Directions: `ann-n`, `ann-s`, `ann-e`, `ann-w`, `ann-nw`, `ann-ne`, `ann-se`, `ann-sw`.
35+
Colors: `ann-amber`, `ann-blue`, `ann-green`, `ann-red`, `ann-purple`, `ann-rainbow`.
36+
37+
## Gotchas
38+
39+
- No `_config.yml` means GitHub Pages defaults apply.
40+
- Deploy is automatic via GitHub Pages on push to main/master branch.

‎Gemfile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
source "https://rubygems.org"
22
gem "github-pages", group: :jekyll_plugins
3+
gem "csv"
4+
gem "webrick"
5+
gem "bigdecimal"
6+
gem "logger"
7+
gem "ostruct"
38

49
group :jekyll_plugins do
510
gem "jekyll-feed", "~> 0.13.0"

‎Gemfile.lock‎

Lines changed: 306 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,306 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (6.0.6.1)
5+
concurrent-ruby (~> 1.0, >= 1.0.2)
6+
i18n (>= 0.7, < 2)
7+
minitest (~> 5.1)
8+
tzinfo (~> 1.1)
9+
zeitwerk (~> 2.2, >= 2.2.2)
10+
addressable (2.9.0)
11+
public_suffix (>= 2.0.2, < 8.0)
12+
base64 (0.3.0)
13+
bigdecimal (4.1.2)
14+
coffee-script (2.4.1)
15+
coffee-script-source
16+
execjs
17+
coffee-script-source (1.11.1)
18+
colorator (1.1.0)
19+
commonmarker (0.17.13)
20+
ruby-enum (~> 0.5)
21+
concurrent-ruby (1.3.8)
22+
csv (3.3.5)
23+
dnsruby (1.74.0)
24+
base64 (>= 0.2)
25+
logger (~> 1.6)
26+
simpleidn (~> 0.2.1)
27+
em-websocket (0.5.3)
28+
eventmachine (>= 0.12.9)
29+
http_parser.rb (~> 0)
30+
ethon (0.18.0)
31+
ffi (>= 1.15.0)
32+
logger
33+
eventmachine (1.2.7)
34+
execjs (2.10.1)
35+
faraday (2.14.3)
36+
faraday-net_http (>= 2.0, < 3.5)
37+
json
38+
logger
39+
faraday-net_http (3.4.4)
40+
net-http (~> 0.5)
41+
ffi (1.17.4-aarch64-linux-gnu)
42+
ffi (1.17.4-aarch64-linux-musl)
43+
ffi (1.17.4-arm-linux-gnu)
44+
ffi (1.17.4-arm-linux-musl)
45+
ffi (1.17.4-arm64-darwin)
46+
ffi (1.17.4-x86_64-darwin)
47+
ffi (1.17.4-x86_64-linux-gnu)
48+
ffi (1.17.4-x86_64-linux-musl)
49+
forwardable-extended (2.6.0)
50+
gemoji (3.0.1)
51+
github-pages (207)
52+
github-pages-health-check (= 1.16.1)
53+
jekyll (= 3.9.0)
54+
jekyll-avatar (= 0.7.0)
55+
jekyll-coffeescript (= 1.1.1)
56+
jekyll-commonmark-ghpages (= 0.1.6)
57+
jekyll-default-layout (= 0.1.4)
58+
jekyll-feed (= 0.13.0)
59+
jekyll-gist (= 1.5.0)
60+
jekyll-github-metadata (= 2.13.0)
61+
jekyll-mentions (= 1.5.1)
62+
jekyll-optional-front-matter (= 0.3.2)
63+
jekyll-paginate (= 1.1.0)
64+
jekyll-readme-index (= 0.3.0)
65+
jekyll-redirect-from (= 0.15.0)
66+
jekyll-relative-links (= 0.6.1)
67+
jekyll-remote-theme (= 0.4.1)
68+
jekyll-sass-converter (= 1.5.2)
69+
jekyll-seo-tag (= 2.6.1)
70+
jekyll-sitemap (= 1.4.0)
71+
jekyll-swiss (= 1.0.0)
72+
jekyll-theme-architect (= 0.1.1)
73+
jekyll-theme-cayman (= 0.1.1)
74+
jekyll-theme-dinky (= 0.1.1)
75+
jekyll-theme-hacker (= 0.1.1)
76+
jekyll-theme-leap-day (= 0.1.1)
77+
jekyll-theme-merlot (= 0.1.1)
78+
jekyll-theme-midnight (= 0.1.1)
79+
jekyll-theme-minimal (= 0.1.1)
80+
jekyll-theme-modernist (= 0.1.1)
81+
jekyll-theme-primer (= 0.5.4)
82+
jekyll-theme-slate (= 0.1.1)
83+
jekyll-theme-tactile (= 0.1.1)
84+
jekyll-theme-time-machine (= 0.1.1)
85+
jekyll-titles-from-headings (= 0.5.3)
86+
jemoji (= 0.11.1)
87+
kramdown (= 2.3.0)
88+
kramdown-parser-gfm (= 1.1.0)
89+
liquid (= 4.0.3)
90+
mercenary (~> 0.3)
91+
minima (= 2.5.1)
92+
nokogiri (>= 1.10.4, < 2.0)
93+
rouge (= 3.19.0)
94+
terminal-table (~> 1.4)
95+
github-pages-health-check (1.16.1)
96+
addressable (~> 2.3)
97+
dnsruby (~> 1.60)
98+
octokit (~> 4.0)
99+
public_suffix (~> 3.0)
100+
typhoeus (~> 1.3)
101+
html-pipeline (2.14.3)
102+
activesupport (>= 2)
103+
nokogiri (>= 1.4)
104+
http_parser.rb (0.8.1)
105+
i18n (0.9.5)
106+
concurrent-ruby (~> 1.0)
107+
jekyll (3.9.0)
108+
addressable (~> 2.4)
109+
colorator (~> 1.0)
110+
em-websocket (~> 0.5)
111+
i18n (~> 0.7)
112+
jekyll-sass-converter (~> 1.0)
113+
jekyll-watch (~> 2.0)
114+
kramdown (>= 1.17, < 3)
115+
liquid (~> 4.0)
116+
mercenary (~> 0.3.3)
117+
pathutil (~> 0.9)
118+
rouge (>= 1.7, < 4)
119+
safe_yaml (~> 1.0)
120+
jekyll-avatar (0.7.0)
121+
jekyll (>= 3.0, < 5.0)
122+
jekyll-coffeescript (1.1.1)
123+
coffee-script (~> 2.2)
124+
coffee-script-source (~> 1.11.1)
125+
jekyll-commonmark (1.3.1)
126+
commonmarker (~> 0.14)
127+
jekyll (>= 3.7, < 5.0)
128+
jekyll-commonmark-ghpages (0.1.6)
129+
commonmarker (~> 0.17.6)
130+
jekyll-commonmark (~> 1.2)
131+
rouge (>= 2.0, < 4.0)
132+
jekyll-default-layout (0.1.4)
133+
jekyll (~> 3.0)
134+
jekyll-feed (0.13.0)
135+
jekyll (>= 3.7, < 5.0)
136+
jekyll-gist (1.5.0)
137+
octokit (~> 4.2)
138+
jekyll-github-metadata (2.13.0)
139+
jekyll (>= 3.4, < 5.0)
140+
octokit (~> 4.0, != 4.4.0)
141+
jekyll-mentions (1.5.1)
142+
html-pipeline (~> 2.3)
143+
jekyll (>= 3.7, < 5.0)
144+
jekyll-optional-front-matter (0.3.2)
145+
jekyll (>= 3.0, < 5.0)
146+
jekyll-paginate (1.1.0)
147+
jekyll-readme-index (0.3.0)
148+
jekyll (>= 3.0, < 5.0)
149+
jekyll-redirect-from (0.15.0)
150+
jekyll (>= 3.3, < 5.0)
151+
jekyll-relative-links (0.6.1)
152+
jekyll (>= 3.3, < 5.0)
153+
jekyll-remote-theme (0.4.1)
154+
addressable (~> 2.0)
155+
jekyll (>= 3.5, < 5.0)
156+
rubyzip (>= 1.3.0)
157+
jekyll-sass-converter (1.5.2)
158+
sass (~> 3.4)
159+
jekyll-seo-tag (2.6.1)
160+
jekyll (>= 3.3, < 5.0)
161+
jekyll-sitemap (1.4.0)
162+
jekyll (>= 3.7, < 5.0)
163+
jekyll-swiss (1.0.0)
164+
jekyll-theme-architect (0.1.1)
165+
jekyll (~> 3.5)
166+
jekyll-seo-tag (~> 2.0)
167+
jekyll-theme-cayman (0.1.1)
168+
jekyll (~> 3.5)
169+
jekyll-seo-tag (~> 2.0)
170+
jekyll-theme-dinky (0.1.1)
171+
jekyll (~> 3.5)
172+
jekyll-seo-tag (~> 2.0)
173+
jekyll-theme-hacker (0.1.1)
174+
jekyll (~> 3.5)
175+
jekyll-seo-tag (~> 2.0)
176+
jekyll-theme-leap-day (0.1.1)
177+
jekyll (~> 3.5)
178+
jekyll-seo-tag (~> 2.0)
179+
jekyll-theme-merlot (0.1.1)
180+
jekyll (~> 3.5)
181+
jekyll-seo-tag (~> 2.0)
182+
jekyll-theme-midnight (0.1.1)
183+
jekyll (~> 3.5)
184+
jekyll-seo-tag (~> 2.0)
185+
jekyll-theme-minimal (0.1.1)
186+
jekyll (~> 3.5)
187+
jekyll-seo-tag (~> 2.0)
188+
jekyll-theme-modernist (0.1.1)
189+
jekyll (~> 3.5)
190+
jekyll-seo-tag (~> 2.0)
191+
jekyll-theme-primer (0.5.4)
192+
jekyll (> 3.5, < 5.0)
193+
jekyll-github-metadata (~> 2.9)
194+
jekyll-seo-tag (~> 2.0)
195+
jekyll-theme-slate (0.1.1)
196+
jekyll (~> 3.5)
197+
jekyll-seo-tag (~> 2.0)
198+
jekyll-theme-tactile (0.1.1)
199+
jekyll (~> 3.5)
200+
jekyll-seo-tag (~> 2.0)
201+
jekyll-theme-time-machine (0.1.1)
202+
jekyll (~> 3.5)
203+
jekyll-seo-tag (~> 2.0)
204+
jekyll-titles-from-headings (0.5.3)
205+
jekyll (>= 3.3, < 5.0)
206+
jekyll-watch (2.2.1)
207+
listen (~> 3.0)
208+
jemoji (0.11.1)
209+
gemoji (~> 3.0)
210+
html-pipeline (~> 2.2)
211+
jekyll (>= 3.0, < 5.0)
212+
json (2.21.1)
213+
kramdown (2.3.0)
214+
rexml
215+
kramdown-parser-gfm (1.1.0)
216+
kramdown (~> 2.0)
217+
liquid (4.0.3)
218+
listen (3.10.0)
219+
logger
220+
rb-fsevent (~> 0.10, >= 0.10.3)
221+
rb-inotify (~> 0.9, >= 0.9.10)
222+
logger (1.7.0)
223+
mercenary (0.3.6)
224+
minima (2.5.1)
225+
jekyll (>= 3.5, < 5.0)
226+
jekyll-feed (~> 0.9)
227+
jekyll-seo-tag (~> 2.1)
228+
minitest (5.27.0)
229+
net-http (0.9.1)
230+
uri (>= 0.11.1)
231+
nokogiri (1.19.4-aarch64-linux-gnu)
232+
racc (~> 1.4)
233+
nokogiri (1.19.4-aarch64-linux-musl)
234+
racc (~> 1.4)
235+
nokogiri (1.19.4-arm-linux-gnu)
236+
racc (~> 1.4)
237+
nokogiri (1.19.4-arm-linux-musl)
238+
racc (~> 1.4)
239+
nokogiri (1.19.4-arm64-darwin)
240+
racc (~> 1.4)
241+
nokogiri (1.19.4-x86_64-darwin)
242+
racc (~> 1.4)
243+
nokogiri (1.19.4-x86_64-linux-gnu)
244+
racc (~> 1.4)
245+
nokogiri (1.19.4-x86_64-linux-musl)
246+
racc (~> 1.4)
247+
octokit (4.25.1)
248+
faraday (>= 1, < 3)
249+
sawyer (~> 0.9)
250+
ostruct (0.6.3)
251+
pathutil (0.16.2)
252+
forwardable-extended (~> 2.6)
253+
public_suffix (3.1.1)
254+
racc (1.8.1)
255+
rb-fsevent (0.11.2)
256+
rb-inotify (0.11.1)
257+
ffi (~> 1.0)
258+
rexml (3.4.4)
259+
rouge (3.19.0)
260+
ruby-enum (0.9.0)
261+
i18n
262+
rubyzip (3.4.1)
263+
safe_yaml (1.0.5)
264+
sass (3.7.4)
265+
sass-listen (~> 4.0.0)
266+
sass-listen (4.0.0)
267+
rb-fsevent (~> 0.9, >= 0.9.4)
268+
rb-inotify (~> 0.9, >= 0.9.7)
269+
sawyer (0.9.3)
270+
addressable (>= 2.3.5)
271+
faraday (>= 0.17.3, < 3)
272+
simpleidn (0.2.3)
273+
terminal-table (1.8.0)
274+
unicode-display_width (~> 1.1, >= 1.1.1)
275+
thread_safe (0.3.6)
276+
typhoeus (1.6.0)
277+
ethon (>= 0.18.0)
278+
tzinfo (1.2.11)
279+
thread_safe (~> 0.1)
280+
unicode-display_width (1.8.0)
281+
uri (1.1.1)
282+
webrick (1.9.2)
283+
zeitwerk (2.8.2)
284+
285+
PLATFORMS
286+
aarch64-linux-gnu
287+
aarch64-linux-musl
288+
arm-linux-gnu
289+
arm-linux-musl
290+
arm64-darwin
291+
x86_64-darwin
292+
x86_64-linux-gnu
293+
x86_64-linux-musl
294+
295+
DEPENDENCIES
296+
bigdecimal
297+
csv
298+
github-pages
299+
jekyll-feed (~> 0.13.0)
300+
jekyll-seo-tag (~> 2.6.1)
301+
logger
302+
ostruct
303+
webrick
304+
305+
BUNDLED WITH
306+
2.6.6

0 commit comments

Comments
 (0)