Skip to content

Commit c4dba0c

Browse files
authored
Merge pull request #121 from DenisValeev/codex/setup-jekyll-for-aidocs
Switch ai docs to Jekyll
2 parents 8ef9ec7 + 7abbd3c commit c4dba0c

16 files changed

Lines changed: 339 additions & 214 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules/
22
playwright-report/
33
test-results/
4+
_site/

.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ This project is a static toolbox site. The landing page (`index.html`) lists sma
3232

3333
## Documentation
3434
- The `ai_docs/` directory hosts the Markdown knowledge base. Update the relevant guides whenever you change workflows, scripts, or datasets so the docs remain authoritative.
35-
- When you add, remove, or rename a guide, update the `guides` array in `ai_docs/index.html` so the navigation stays in sync.
36-
- After editing documentation, open `ai_docs/index.html` in a browser (or via `npx serve .`) to confirm the Markdown renders through Marked and the hash navigation works.
35+
- Guides are rendered by Jekyll now—add or rename a page by editing the Markdown in `ai_docs/docs/`, keeping the YAML front matter (`layout`, `title`, `summary`, `nav_order`, `permalink`, and `last_updated`) up to date.
36+
- After editing documentation, run `bundle exec jekyll build` (or `bundle exec jekyll serve`) to confirm the site compiles and the navigation reflects your changes before committing.

Gemfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source "https://rubygems.org"
2+
3+
gem "jekyll", "~> 4.3"
4+
gem "webrick", "~> 1.8"

Gemfile.lock

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
base64 (0.3.0)
7+
bigdecimal (3.2.3)
8+
colorator (1.1.0)
9+
concurrent-ruby (1.3.5)
10+
csv (3.3.5)
11+
em-websocket (0.5.3)
12+
eventmachine (>= 0.12.9)
13+
http_parser.rb (~> 0)
14+
eventmachine (1.2.7)
15+
ffi (1.17.2)
16+
ffi (1.17.2-aarch64-linux-gnu)
17+
ffi (1.17.2-aarch64-linux-musl)
18+
ffi (1.17.2-arm-linux-gnu)
19+
ffi (1.17.2-arm-linux-musl)
20+
ffi (1.17.2-arm64-darwin)
21+
ffi (1.17.2-x86-linux-gnu)
22+
ffi (1.17.2-x86-linux-musl)
23+
ffi (1.17.2-x86_64-darwin)
24+
ffi (1.17.2-x86_64-linux-gnu)
25+
ffi (1.17.2-x86_64-linux-musl)
26+
forwardable-extended (2.6.0)
27+
google-protobuf (4.32.1)
28+
bigdecimal
29+
rake (>= 13)
30+
google-protobuf (4.32.1-aarch64-linux-gnu)
31+
bigdecimal
32+
rake (>= 13)
33+
google-protobuf (4.32.1-aarch64-linux-musl)
34+
bigdecimal
35+
rake (>= 13)
36+
google-protobuf (4.32.1-arm64-darwin)
37+
bigdecimal
38+
rake (>= 13)
39+
google-protobuf (4.32.1-x86-linux-gnu)
40+
bigdecimal
41+
rake (>= 13)
42+
google-protobuf (4.32.1-x86-linux-musl)
43+
bigdecimal
44+
rake (>= 13)
45+
google-protobuf (4.32.1-x86_64-darwin)
46+
bigdecimal
47+
rake (>= 13)
48+
google-protobuf (4.32.1-x86_64-linux-gnu)
49+
bigdecimal
50+
rake (>= 13)
51+
google-protobuf (4.32.1-x86_64-linux-musl)
52+
bigdecimal
53+
rake (>= 13)
54+
http_parser.rb (0.8.0)
55+
i18n (1.14.7)
56+
concurrent-ruby (~> 1.0)
57+
jekyll (4.4.1)
58+
addressable (~> 2.4)
59+
base64 (~> 0.2)
60+
colorator (~> 1.0)
61+
csv (~> 3.0)
62+
em-websocket (~> 0.5)
63+
i18n (~> 1.0)
64+
jekyll-sass-converter (>= 2.0, < 4.0)
65+
jekyll-watch (~> 2.0)
66+
json (~> 2.6)
67+
kramdown (~> 2.3, >= 2.3.1)
68+
kramdown-parser-gfm (~> 1.0)
69+
liquid (~> 4.0)
70+
mercenary (~> 0.3, >= 0.3.6)
71+
pathutil (~> 0.9)
72+
rouge (>= 3.0, < 5.0)
73+
safe_yaml (~> 1.0)
74+
terminal-table (>= 1.8, < 4.0)
75+
webrick (~> 1.7)
76+
jekyll-sass-converter (3.1.0)
77+
sass-embedded (~> 1.75)
78+
jekyll-watch (2.2.1)
79+
listen (~> 3.0)
80+
json (2.15.0)
81+
kramdown (2.5.1)
82+
rexml (>= 3.3.9)
83+
kramdown-parser-gfm (1.1.0)
84+
kramdown (~> 2.0)
85+
liquid (4.0.4)
86+
listen (3.9.0)
87+
rb-fsevent (~> 0.10, >= 0.10.3)
88+
rb-inotify (~> 0.9, >= 0.9.10)
89+
mercenary (0.4.0)
90+
pathutil (0.16.2)
91+
forwardable-extended (~> 2.6)
92+
public_suffix (6.0.2)
93+
rake (13.3.0)
94+
rb-fsevent (0.11.2)
95+
rb-inotify (0.11.1)
96+
ffi (~> 1.0)
97+
rexml (3.4.4)
98+
rouge (4.6.0)
99+
safe_yaml (1.0.5)
100+
sass-embedded (1.93.2)
101+
google-protobuf (~> 4.31)
102+
rake (>= 13)
103+
sass-embedded (1.93.2-aarch64-linux-android)
104+
google-protobuf (~> 4.31)
105+
sass-embedded (1.93.2-aarch64-linux-gnu)
106+
google-protobuf (~> 4.31)
107+
sass-embedded (1.93.2-aarch64-linux-musl)
108+
google-protobuf (~> 4.31)
109+
sass-embedded (1.93.2-arm-linux-androideabi)
110+
google-protobuf (~> 4.31)
111+
sass-embedded (1.93.2-arm-linux-gnueabihf)
112+
google-protobuf (~> 4.31)
113+
sass-embedded (1.93.2-arm-linux-musleabihf)
114+
google-protobuf (~> 4.31)
115+
sass-embedded (1.93.2-arm64-darwin)
116+
google-protobuf (~> 4.31)
117+
sass-embedded (1.93.2-riscv64-linux-android)
118+
google-protobuf (~> 4.31)
119+
sass-embedded (1.93.2-riscv64-linux-gnu)
120+
google-protobuf (~> 4.31)
121+
sass-embedded (1.93.2-riscv64-linux-musl)
122+
google-protobuf (~> 4.31)
123+
sass-embedded (1.93.2-x86_64-darwin)
124+
google-protobuf (~> 4.31)
125+
sass-embedded (1.93.2-x86_64-linux-android)
126+
google-protobuf (~> 4.31)
127+
sass-embedded (1.93.2-x86_64-linux-gnu)
128+
google-protobuf (~> 4.31)
129+
sass-embedded (1.93.2-x86_64-linux-musl)
130+
google-protobuf (~> 4.31)
131+
terminal-table (3.0.2)
132+
unicode-display_width (>= 1.1.1, < 3)
133+
unicode-display_width (2.6.0)
134+
webrick (1.9.1)
135+
136+
PLATFORMS
137+
aarch64-linux-android
138+
aarch64-linux-gnu
139+
aarch64-linux-musl
140+
arm-linux-androideabi
141+
arm-linux-gnu
142+
arm-linux-gnueabihf
143+
arm-linux-musl
144+
arm-linux-musleabihf
145+
arm64-darwin
146+
riscv64-linux-android
147+
riscv64-linux-gnu
148+
riscv64-linux-musl
149+
ruby
150+
x86-linux-gnu
151+
x86-linux-musl
152+
x86_64-darwin
153+
x86_64-linux-android
154+
x86_64-linux-gnu
155+
x86_64-linux-musl
156+
157+
DEPENDENCIES
158+
jekyll (~> 4.3)
159+
webrick (~> 1.8)
160+
161+
BUNDLED WITH
162+
2.6.7

_config.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Jekyll configuration for the toolbox site
2+
3+
# Site metadata
4+
name: "denisvaleev.github.io"
5+
title: "denisvaleev.github.io"
6+
description: "Static toolbox of browser-based utilities and documentation."
7+
baseurl: ""
8+
url: ""
9+
10+
# Markdown processing
11+
markdown: kramdown
12+
kramdown:
13+
input: GFM
14+
hard_wrap: false
15+
16+
# Output options
17+
permalink: pretty
18+
19+
# Directories that should be ignored when building the site
20+
exclude:
21+
- Gemfile
22+
- Gemfile.lock
23+
- node_modules
24+
- package-lock.json
25+
- package.json
26+
- playwright-report
27+
- test-results
28+
- tools
29+
- tests
30+
31+
# Keep everything else so existing static assets ship unchanged

0 commit comments

Comments
 (0)