jekyll-theme-zer0 0.21.0 → 0.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +74 -0
- data/README.md +86 -46
- data/_data/authors.yml +12 -3
- data/_data/features.yml +1 -1
- data/_data/glossary.yml +101 -0
- data/_data/navigation/docs.yml +12 -0
- data/_data/navigation/home.yml +2 -2
- data/_data/navigation/main.yml +2 -8
- data/_data/prompts.yml +184 -0
- data/_includes/components/author-eeat.html +133 -0
- data/_includes/components/cookie-consent.html +9 -9
- data/_includes/components/dev-shortcuts.html +36 -27
- data/_includes/components/env-detect.html +14 -0
- data/_includes/components/env-switcher.html +38 -16
- data/_includes/components/halfmoon.html +31 -20
- data/_includes/components/info-section.html +4 -3
- data/_includes/components/js-cdn.html +8 -15
- data/_includes/components/mermaid.html +13 -9
- data/_includes/components/powered-by.html +5 -3
- data/_includes/content/intro.html +64 -4
- data/_includes/content/jsonld-faq.html +47 -0
- data/_includes/content/jsonld-software.html +121 -0
- data/_includes/content/sitemap.html +2 -2
- data/_includes/core/branding.html +9 -7
- data/_includes/core/footer.html +12 -9
- data/_includes/core/head.html +17 -14
- data/_includes/core/header.html +33 -21
- data/_includes/navigation/navbar.html +130 -124
- data/_includes/navigation/sidebar-left.html +3 -3
- data/_includes/navigation/sidebar-right.html +4 -8
- data/_includes/search-data.json +1 -2
- data/_layouts/landing.html +8 -3
- data/_layouts/root.html +4 -4
- data/_layouts/sitemap-collection.html +20 -10
- data/_sass/core/_docs-layout.scss +756 -0
- data/_sass/core/_navbar.scss +522 -69
- data/_sass/core/_offcanvas-panels.scss +48 -0
- data/_sass/core/_syntax.scss +1 -51
- data/_sass/core/_theme.scss +2 -249
- data/_sass/core/_variables.scss +1 -54
- data/_sass/core/code-copy.scss +6 -6
- data/_sass/custom.scss +119 -133
- data/_sass/theme/_color-modes.scss +3 -0
- data/_sass/theme/_css-variables.scss +29 -0
- data/_sass/theme/_wizard-mode.scss +31 -0
- data/assets/css/custom.css +5 -120
- data/assets/css/main.scss +6 -2
- data/assets/css/stats.css +3 -0
- data/assets/css/theme-npm-entry.scss +6 -0
- data/assets/css/vendor/.gitkeep +0 -0
- data/assets/images/authors/bamr87.png +0 -0
- data/assets/js/auto-hide-nav.js +71 -20
- data/assets/js/color-modes.js +8 -2
- data/assets/js/halfmoon.js +8 -2
- data/assets/js/myScript.js +4 -12
- data/assets/js/navigation.js +174 -19
- data/assets/js/search-modal.js +50 -7
- data/assets/vendor/bootstrap/css/bootstrap.min.css +5 -0
- data/assets/vendor/bootstrap/js/bootstrap.bundle.min.js +6 -0
- data/assets/vendor/bootstrap-icons/font/bootstrap-icons.css +2018 -0
- data/assets/vendor/bootstrap-icons/font/fonts/bootstrap-icons.woff +0 -0
- data/assets/vendor/bootstrap-icons/font/fonts/bootstrap-icons.woff2 +0 -0
- data/assets/vendor/font-awesome/css/all.min.css +9 -0
- data/assets/vendor/font-awesome/webfonts/fa-brands-400.ttf +0 -0
- data/assets/vendor/font-awesome/webfonts/fa-brands-400.woff2 +0 -0
- data/assets/vendor/font-awesome/webfonts/fa-regular-400.ttf +0 -0
- data/assets/vendor/font-awesome/webfonts/fa-regular-400.woff2 +0 -0
- data/assets/vendor/font-awesome/webfonts/fa-solid-900.ttf +0 -0
- data/assets/vendor/font-awesome/webfonts/fa-solid-900.woff2 +0 -0
- data/assets/vendor/font-awesome/webfonts/fa-v4compatibility.ttf +0 -0
- data/assets/vendor/font-awesome/webfonts/fa-v4compatibility.woff2 +0 -0
- data/assets/vendor/github-calendar/github-calendar-responsive.css +231 -0
- data/assets/vendor/github-calendar/github-calendar.min.js +240 -0
- data/assets/vendor/jquery/jquery-3.7.1.min.js +2 -0
- data/assets/vendor/mathjax/es5/adaptors/liteDOM.js +1 -0
- data/assets/vendor/mathjax/es5/core.js +1 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_AMS-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Bold.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Calligraphic-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Bold.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Fraktur-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Main-Bold.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Main-Italic.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Main-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Math-BoldItalic.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Math-Italic.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Math-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Bold.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Italic.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_SansSerif-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Script-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Size2-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Size3-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Size4-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Typewriter-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Bold.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Vector-Regular.woff +0 -0
- data/assets/vendor/mathjax/es5/output/chtml/fonts/woff-v2/MathJax_Zero.woff +0 -0
- data/assets/vendor/mathjax/es5/startup.js +1 -0
- data/assets/vendor/mathjax/es5/tex-mml-chtml.js +1 -0
- data/assets/vendor/mermaid/mermaid.min.js +2029 -0
- data/scripts/bin/build +12 -2
- data/scripts/lib/common.sh +55 -0
- data/scripts/lib/gem.sh +7 -0
- data/scripts/lib/validation.sh +9 -1
- data/scripts/lib/version.sh +41 -0
- data/scripts/test/integration/mermaid +1 -1
- data/scripts/vendor-install.sh +196 -0
- metadata +62 -3
- data/_sass/core/_docs.scss +0 -3219
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ce41ce999bd5b54f7cfcac020229d628824553947a7afb5b06d7c4b4b70a8359
|
|
4
|
+
data.tar.gz: 8aa1e03d1a80f7e3dbd4e48bd60b6032f9b92937b2d4b6659917d5be1450dd4a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 294d8297f16eb43703c573cfb7fc731d27ef2927062873653899c19e72866c1fec39d9844c5706458705dafa04621d431c06284582a113fb310cebf18cc85585
|
|
7
|
+
data.tar.gz: '0299069c10c3fa32846c4879f4accc6ac555998c36fd8f9cffca821090839743301469d1894cc79b3bcb9f3b1c127bd1497335b3c3e6b17390235b15e7390be8'
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,79 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.22.0] - 2026-04-01
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
- **Copilot Agent dropdown**: New `btn-success` dropdown in the intro section action button group that lists AI prompt templates, each opening a pre-filled GitHub issue assigned to `@copilot` with the selected prompt body, page context, and environment metadata
|
|
7
|
+
- **`_data/prompts.yml`**: Data-driven prompt registry with 9 built-in templates (article-review, code-implementation, code-refactoring, debugging, documentation, requirements-analysis, system-design, test-generation, prompt-engineering)
|
|
8
|
+
- **`docs/implementation/copilot-agent-prompt-button.md`**: Full implementation guide covering architecture, configuration, prompt registry, issue body structure, customization, troubleshooting, and FAQ
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
- **`_includes/content/intro.html`**: Replaced single Copilot Agent link with a prompt-selection dropdown; `repo_branch` now sourced from `site.branch | default: "main"` (fixes hardcoded `master`); file path uses dedicated `file_path` variable; issue title format is `[Prompt Label] Page Title` with `ai-agent` label pre-applied
|
|
12
|
+
- **`docs/implementation/README.md`**: Added Copilot Agent Prompt Button entry to contents table
|
|
13
|
+
|
|
14
|
+
## [0.21.6] - 2026-03-30
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
- Version bump: patch release
|
|
18
|
+
|
|
19
|
+
### Commits in this release
|
|
20
|
+
- 56c70b8 docs: fix Quick Links, harmonize bash commands, and update version references across READMEs (#42)
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## [0.21.5] - 2026-03-30
|
|
24
|
+
|
|
25
|
+
### Changed
|
|
26
|
+
- Version bump: patch release
|
|
27
|
+
|
|
28
|
+
### Commits in this release
|
|
29
|
+
- c74f26d Automate README.md version sync and fix GitHub release dispatch in release workflow (#40)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
## [0.21.4] - 2026-03-29
|
|
33
|
+
|
|
34
|
+
### Changed
|
|
35
|
+
- Version bump: patch release
|
|
36
|
+
|
|
37
|
+
### Commits in this release
|
|
38
|
+
- 3c96620 feat: vendor assets, theme architecture, CI and docs (v0.21.3) (#39)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
## [0.21.3] - 2026-03-29
|
|
42
|
+
|
|
43
|
+
### Changed
|
|
44
|
+
- **Test runner**: When `test.conf` sets a non-default `TEST_TIMEOUT_DEFAULT`, pass `--timeout` only to suites whose scripts accept it (`core`, `deployment`, `quality`). Avoids `Unknown option: --timeout` on installation and site-generation suites.
|
|
45
|
+
- **Vendor assets (GitHub Pages)**: Bootstrap, jQuery, Bootstrap Icons, MathJax, Mermaid, Font Awesome, and GitHub Calendar load from committed `assets/vendor/` with `relative_url` (no runtime CDN for core assets). Added `vendor-manifest.json`, `scripts/vendor-install.sh`, and `npm run vendor:install`. `.gitignore` uses `/vendor/` for Bundler only; removed blanket `vendor/` from Jekyll `exclude` so `assets/vendor/` is published. Docker base image includes `jq` for vendor installs; `scripts/bin/build` runs vendor-install before gem build.
|
|
46
|
+
- **Mermaid vendor source**: `mermaid` is a devDependency; `npm run vendor:mermaid` copies `node_modules/mermaid/dist/mermaid.min.js` into `assets/vendor/mermaid/`. The jsDelivr Mermaid entry was removed from `vendor-manifest.json`; `vendor-install.sh` copies from npm when `node_modules` is present.
|
|
47
|
+
- Version bump: patch release
|
|
48
|
+
- **CSS architecture**: Removed unused `assets/css/custom.css` (legacy `#mainNav`); overrides use `_sass/custom.scss` or optional `user-overrides.css`. Replaced vendored `_sass/core/_docs.scss` (~3.2k lines) with trimmed `_sass/core/_docs-layout.scss`. Theme modes: `_sass/theme/_color-modes.scss` re-exports `_wizard-mode.scss` (wizard Sass/CSS) and `_css-variables.scss` (`--bd-*` tokens); dropped duplicate blocks from `_theme.scss`, duplicate Bootstrap font/line-height block in `_variables.scss`, and unused social/base16 duplicates from `_variables.scss`. Feature metadata now points styles at `_docs-layout.scss`.
|
|
49
|
+
- **Optional npm Bootstrap**: Added `package.json` with `npm run css:bootstrap` (Dart Sass + Bootstrap 5.3.3) producing `assets/css/vendor/bootstrap-from-npm.css`; documented alternate `<link>` in `_includes/core/head.html`. `stats.css` remains a conditional stylesheet for the stats layout only.
|
|
50
|
+
|
|
51
|
+
### Commits in this release
|
|
52
|
+
- 1fd2061 Enhance navigation UX: responsive design, accessibility, and interaction polish (#25)
|
|
53
|
+
- 9a27ad7 feat(aieo): add structured data, E-E-A-T signals, FAQ, glossary, and roadmap pages (#38)
|
|
54
|
+
- 96a31f9 chore(deps): update Ruby gem dependencies (#37)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
## [0.21.2] - 2026-03-21
|
|
58
|
+
|
|
59
|
+
### Changed
|
|
60
|
+
- Version bump: patch release
|
|
61
|
+
- Release tooling: RubyGems publishing now supports API-key auth via `.env` (`RUBY_API_KEY` mapped to `GEM_HOST_API_KEY`)
|
|
62
|
+
|
|
63
|
+
### Commits in this release
|
|
64
|
+
- 34bed37 chore(deps): update Ruby gem dependencies (#31)
|
|
65
|
+
- 50ebdd4 chore(deps): update Ruby gem dependencies (#32)
|
|
66
|
+
|
|
67
|
+
## [0.21.1] - 2026-03-13
|
|
68
|
+
|
|
69
|
+
### Changed
|
|
70
|
+
- Version bump: patch release
|
|
71
|
+
|
|
72
|
+
### Commits in this release
|
|
73
|
+
- 9665afd feat(templates): add README.md for templates directory and usage instructions
|
|
74
|
+
- cc81bd9 chore(deps): update Ruby gem dependencies (#24)
|
|
75
|
+
|
|
76
|
+
|
|
3
77
|
## [0.21.0] - 2026-02-01
|
|
4
78
|
|
|
5
79
|
### Added
|
data/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: zer0-mistakes
|
|
3
3
|
sub-title: Jekyll Theme
|
|
4
4
|
description: GitHub Pages compatible Jekyll theme with Bootstrap 5.3, featuring automated installation and comprehensive documentation.
|
|
5
|
-
version: 0.
|
|
5
|
+
version: 0.21.6
|
|
6
6
|
layout: landing
|
|
7
7
|
tags:
|
|
8
8
|
- jekyll
|
|
@@ -14,7 +14,7 @@ categories:
|
|
|
14
14
|
- docker
|
|
15
15
|
- bootstrap
|
|
16
16
|
created: 2024-02-10T23:51:11.480Z
|
|
17
|
-
lastmod: 2026-
|
|
17
|
+
lastmod: 2026-03-30T15:07:00.000Z
|
|
18
18
|
draft: false
|
|
19
19
|
permalink: /
|
|
20
20
|
slug: zer0
|
|
@@ -23,7 +23,7 @@ keywords:
|
|
|
23
23
|
- docker
|
|
24
24
|
- remote-theme
|
|
25
25
|
- github-pages
|
|
26
|
-
date: 2026-
|
|
26
|
+
date: 2026-03-29T12:00:00.000Z
|
|
27
27
|
snippet: GitHub Pages compatible Jekyll theme with Bootstrap 5
|
|
28
28
|
comments: true
|
|
29
29
|
mermaid: true
|
|
@@ -62,8 +62,11 @@ excerpt: "Professional Jekyll theme for GitHub Pages with Bootstrap 5.3, automat
|
|
|
62
62
|
- [Documentation](#-documentation)
|
|
63
63
|
- [Release System](#-release-system)
|
|
64
64
|
- [Roadmap](#-roadmap)
|
|
65
|
+
- [FAQ](/faq/)
|
|
66
|
+
- [Glossary](/glossary/)
|
|
65
67
|
- [Contributing](#-contributing)
|
|
66
68
|
- [Support](#-support)
|
|
69
|
+
- [AIEO-Optimized](#-aieo-optimized--built-for-ai-citation)
|
|
67
70
|
|
|
68
71
|
---
|
|
69
72
|
|
|
@@ -98,9 +101,9 @@ graph LR
|
|
|
98
101
|
|
|
99
102
|
| Challenge | Traditional Jekyll | zer0-mistakes |
|
|
100
103
|
|-----------|-------------------|---------------|
|
|
101
|
-
| **Setup Time** | 15-30 minutes | **2-5 minutes** |
|
|
102
|
-
| **Success Rate** | ~60% | **~95%** |
|
|
103
|
-
| **Platform Support** | Limited | **Universal** |
|
|
104
|
+
| **Setup Time** | 15-30 minutes | **2-5 minutes** ([benchmarked via install.sh](https://github.com/bamr87/zer0-mistakes/blob/main/install.sh)) |
|
|
105
|
+
| **Success Rate** | ~60% | **~95%** ([self-healing error recovery](https://github.com/bamr87/zer0-mistakes/blob/main/install.sh#L1)) |
|
|
106
|
+
| **Platform Support** | Limited | **Universal** ([macOS, Linux, Windows/WSL via Docker](https://github.com/bamr87/zer0-mistakes/blob/main/docker-compose.yml)) |
|
|
104
107
|
| **Error Handling** | Manual debugging | **Automated** |
|
|
105
108
|
| **Dependencies** | Ruby + Bundler + Jekyll | **Docker only** |
|
|
106
109
|
|
|
@@ -129,22 +132,22 @@ docker-compose up
|
|
|
129
132
|
```mermaid
|
|
130
133
|
sequenceDiagram
|
|
131
134
|
participant You
|
|
132
|
-
participant Install Script
|
|
135
|
+
participant InstallScript as Install Script
|
|
133
136
|
participant Docker
|
|
134
137
|
participant Browser
|
|
135
|
-
|
|
136
|
-
You->>
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
138
|
+
|
|
139
|
+
You->>InstallScript: curl ... | bash
|
|
140
|
+
InstallScript->>InstallScript: Detect platform
|
|
141
|
+
InstallScript->>InstallScript: Download theme files
|
|
142
|
+
InstallScript->>InstallScript: Configure Docker
|
|
143
|
+
InstallScript-->>You: ✅ Ready
|
|
144
|
+
|
|
142
145
|
You->>Docker: docker-compose up
|
|
143
146
|
Docker->>Docker: Build Jekyll container
|
|
144
147
|
Docker->>Docker: Install dependencies
|
|
145
148
|
Docker-->>Browser: Serve on :4000
|
|
146
|
-
|
|
147
|
-
Browser-->>You: 🎉 Live site
|
|
149
|
+
|
|
150
|
+
Browser-->>You: 🎉 Live site
|
|
148
151
|
```
|
|
149
152
|
|
|
150
153
|
---
|
|
@@ -411,7 +414,7 @@ docker-compose up
|
|
|
411
414
|
|
|
412
415
|
```ruby
|
|
413
416
|
# Gemfile
|
|
414
|
-
gem "jekyll-theme-zer0", "~> 0.
|
|
417
|
+
gem "jekyll-theme-zer0", "~> 0.21"
|
|
415
418
|
```
|
|
416
419
|
|
|
417
420
|
---
|
|
@@ -455,9 +458,9 @@ graph TD
|
|
|
455
458
|
|-----------|---------|-----------|
|
|
456
459
|
| `_layouts/` | Page templates | `default.html`, `journals.html`, `landing.html`, `notebook.html` |
|
|
457
460
|
| `_includes/` | Reusable components | `core/`, `components/`, `analytics/`, `navigation/` |
|
|
458
|
-
| `_sass/` | Stylesheets | `custom.scss`, `notebooks.scss`, `core/` |
|
|
459
|
-
| `assets/` | Static files | `css/`, `js
|
|
460
|
-
| `scripts/` | Automation | `release`, `build`, `convert-notebooks.sh` |
|
|
461
|
+
| `_sass/` | Stylesheets | `custom.scss`, `notebooks.scss`, `core/` (`_variables`, `_docs-layout`, …), `theme/` (`_css-variables`, `_wizard-mode`) |
|
|
462
|
+
| `assets/` | Static files | `css/`, `js/`, `images/`, **`vendor/`** (Bootstrap, jQuery, MathJax, Mermaid, … — committed for GitHub Pages) |
|
|
463
|
+
| `scripts/` | Automation | `release`, `build`, `vendor-install.sh`, `convert-notebooks.sh` |
|
|
461
464
|
| `docs/` | Technical docs | `SIDEBAR_IMPROVEMENTS.md`, `JUPYTER_NOTEBOOKS.md` |
|
|
462
465
|
| `pages/` | Content pages | `privacy-policy.md`, `terms-of-service.md` |
|
|
463
466
|
|
|
@@ -506,6 +509,19 @@ git commit -m "feat: add new component"
|
|
|
506
509
|
|
|
507
510
|
# Docker-specific tests
|
|
508
511
|
./test/test_docker_deployment.sh
|
|
512
|
+
|
|
513
|
+
# Visual / styling checks (Playwright; optional BASE_URL if site already running)
|
|
514
|
+
npm run test:styling
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### Vendor assets (maintainers)
|
|
518
|
+
|
|
519
|
+
Third-party CSS and JavaScript live under `assets/vendor/` so GitHub Pages builds work without npm at publish time. To refresh bundles after changing versions, see [Vendor assets](pages/_docs/development/vendor-assets.md) (published at `/docs/development/vendor-assets/`). Short version:
|
|
520
|
+
|
|
521
|
+
```bash
|
|
522
|
+
npm install
|
|
523
|
+
npm run vendor:install # manifest downloads (+ Mermaid copy when node_modules present)
|
|
524
|
+
# or: ./scripts/vendor-install.sh
|
|
509
525
|
```
|
|
510
526
|
|
|
511
527
|
---
|
|
@@ -585,14 +601,14 @@ graph LR
|
|
|
585
601
|
|
|
586
602
|
| Resource | Description |
|
|
587
603
|
|----------|-------------|
|
|
588
|
-
| [📋 Technical Docs](
|
|
589
|
-
| [📖 User Guides](
|
|
590
|
-
| [🎨 Customization](
|
|
591
|
-
| [📊 Analytics](
|
|
592
|
-
| [🔍 SEO](
|
|
593
|
-
| [📓 Jupyter Notebooks](
|
|
604
|
+
| [📋 Technical Docs](https://github.com/bamr87/zer0-mistakes/tree/main/docs/) | Architecture, systems, implementation |
|
|
605
|
+
| [📖 User Guides](https://zer0-mistakes.com/docs/) | Published tutorials and references |
|
|
606
|
+
| [🎨 Customization](https://zer0-mistakes.com/docs/customization/) | Layouts, styles, navigation guides |
|
|
607
|
+
| [📊 Analytics](https://zer0-mistakes.com/docs/analytics/) | PostHog, Google Analytics setup |
|
|
608
|
+
| [🔍 SEO](https://zer0-mistakes.com/docs/seo/) | Meta tags, sitemap, structured data |
|
|
609
|
+
| [📓 Jupyter Notebooks](https://github.com/bamr87/zer0-mistakes/blob/main/docs/JUPYTER_NOTEBOOKS.md) | Notebook conversion documentation |
|
|
594
610
|
| [📝 PRD](docs/PRD.md) | Product requirements & roadmap |
|
|
595
|
-
| [🔒 Privacy Policy](
|
|
611
|
+
| [🔒 Privacy Policy](https://zer0-mistakes.com/privacy-policy/) | GDPR/CCPA compliant privacy docs |
|
|
596
612
|
|
|
597
613
|
---
|
|
598
614
|
|
|
@@ -633,18 +649,20 @@ flowchart LR
|
|
|
633
649
|
|
|
634
650
|
```bash
|
|
635
651
|
# Preview release
|
|
636
|
-
|
|
652
|
+
bash scripts/release patch --dry-run
|
|
637
653
|
|
|
638
654
|
# Full release
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
655
|
+
bash scripts/release patch # 0.21.5 → 0.21.6
|
|
656
|
+
bash scripts/release minor # 0.21.5 → 0.22.0
|
|
657
|
+
bash scripts/release major # 0.21.5 → 1.0.0
|
|
642
658
|
```
|
|
643
659
|
|
|
644
660
|
---
|
|
645
661
|
|
|
646
662
|
## 🗺 Roadmap
|
|
647
663
|
|
|
664
|
+
See the full [Roadmap page](/roadmap/) for detailed plans and timeline.
|
|
665
|
+
|
|
648
666
|
```mermaid
|
|
649
667
|
gantt
|
|
650
668
|
title zer0-mistakes Roadmap
|
|
@@ -653,19 +671,22 @@ gantt
|
|
|
653
671
|
v0.17 ES6 Navigation :done, 2025-12, 2025-12
|
|
654
672
|
v0.18 Site Search :done, 2026-01, 2026-01
|
|
655
673
|
v0.19 Feature Discovery :done, 2026-01, 2026-01
|
|
674
|
+
v0.20 Navigation Redesign :done, 2026-02, 2026-02
|
|
675
|
+
v0.21 Env Switcher :done, 2026-02, 2026-03
|
|
656
676
|
section Current
|
|
657
|
-
v0.
|
|
677
|
+
v0.22 AIEO Optimization :active, 2026-03, 2026-04
|
|
658
678
|
section Future
|
|
659
|
-
v0.
|
|
660
|
-
v0.
|
|
661
|
-
v1.0
|
|
679
|
+
v0.23 CMS Integration :2026-05, 2026-07
|
|
680
|
+
v0.24 i18n Support :2026-07, 2026-09
|
|
681
|
+
v1.0 Stable Release :milestone, 2027-01, 1d
|
|
662
682
|
```
|
|
663
683
|
|
|
664
684
|
| Version | Target | Features |
|
|
665
685
|
|---------|--------|----------|
|
|
666
|
-
| **v0.
|
|
667
|
-
| **v0.
|
|
668
|
-
| **v0.
|
|
686
|
+
| **v0.21** | Completed | Environment switcher, navigation redesign, settings modal |
|
|
687
|
+
| **v0.22** | Q1 2026 | AIEO optimization, structured data, FAQ, glossary |
|
|
688
|
+
| **v0.23** | Q2 2026 | Headless CMS integration, content API |
|
|
689
|
+
| **v0.24** | Q3 2026 | Multi-language support (i18n) |
|
|
669
690
|
| **v1.0** | Q1 2027 | Stable API, 90%+ test coverage |
|
|
670
691
|
|
|
671
692
|
---
|
|
@@ -710,7 +731,7 @@ git push origin feature/awesome-feature
|
|
|
710
731
|
|
|
711
732
|
| Channel | Link |
|
|
712
733
|
|---------|------|
|
|
713
|
-
| 📖 Documentation | [zer0-mistakes.
|
|
734
|
+
| 📖 Documentation | [zer0-mistakes.com](https://zer0-mistakes.com/) |
|
|
714
735
|
| 🐛 Issues | [GitHub Issues](https://github.com/bamr87/zer0-mistakes/issues) |
|
|
715
736
|
| 💬 Discussions | [GitHub Discussions](https://github.com/bamr87/zer0-mistakes/discussions) |
|
|
716
737
|
| 📧 Email | [support@zer0-mistakes.com](mailto:support@zer0-mistakes.com) |
|
|
@@ -721,12 +742,31 @@ git push origin feature/awesome-feature
|
|
|
721
742
|
|
|
722
743
|
| Metric | Value |
|
|
723
744
|
|--------|-------|
|
|
724
|
-
| **Current Version** | 0.
|
|
725
|
-
| **Documented Features** | 43 |
|
|
726
|
-
| **Setup Time** | 2-5 minutes |
|
|
727
|
-
| **Documentation Pages** | 70+ |
|
|
728
|
-
| **RubyGems Downloads** | 3,000+ |
|
|
729
|
-
| **Lighthouse Score** | 95+ |
|
|
745
|
+
| **Current Version** | 0.21.6 ([RubyGems](https://rubygems.org/gems/jekyll-theme-zer0), [CHANGELOG](/CHANGELOG)) |
|
|
746
|
+
| **Documented Features** | 43 ([Feature Registry](https://github.com/bamr87/zer0-mistakes/blob/main/_data/features.yml)) |
|
|
747
|
+
| **Setup Time** | 2-5 minutes ([install.sh benchmarks](https://github.com/bamr87/zer0-mistakes/blob/main/install.sh)) |
|
|
748
|
+
| **Documentation Pages** | 70+ ([browse docs](/pages/)) |
|
|
749
|
+
| **RubyGems Downloads** | 3,000+ ([rubygems.org](https://rubygems.org/gems/jekyll-theme-zer0)) |
|
|
750
|
+
| **Lighthouse Score** | 95+ ([measured via Chrome DevTools](https://developer.chrome.com/docs/lighthouse/)) |
|
|
751
|
+
|
|
752
|
+
---
|
|
753
|
+
|
|
754
|
+
## 🤖 AIEO-Optimized — Built for AI Citation
|
|
755
|
+
|
|
756
|
+
This site implements [AI Engine Optimization (AIEO)](https://zer0-mistakes.com/glossary/#aieo) to maximize accuracy and depth when AI models cite or summarize its content. Key patterns applied:
|
|
757
|
+
|
|
758
|
+
| AIEO Pattern | Implementation |
|
|
759
|
+
|---|---|
|
|
760
|
+
| **Structured Data** | JSON-LD `SoftwareApplication`, `WebPage`, `Person`, and `FAQPage` schemas in every page head |
|
|
761
|
+
| **Entity Density** | Author profiles, technology names, and version numbers linked to canonical sources |
|
|
762
|
+
| **E-E-A-T Signals** | Visible [author block](/glossary/#e-e-a-t) on the landing page with social proof links |
|
|
763
|
+
| **FAQ Injection** | Dedicated [FAQ page](/faq/) with 12 question-answer pairs and FAQPage schema |
|
|
764
|
+
| **Definitional Precision** | Machine-readable [Glossary](/glossary/) with 20+ key term definitions |
|
|
765
|
+
| **Temporal Anchoring** | Dated [Roadmap](/roadmap/) with past, present, and future milestones |
|
|
766
|
+
| **Substantiated Claims** | Project stats table links to RubyGems, CHANGELOG, and Feature Registry as evidence |
|
|
767
|
+
| **Procedural Clarity** | Step-by-step installation with Mermaid sequence diagrams and comparison tables |
|
|
768
|
+
|
|
769
|
+
All AIEO enhancements are backward-compatible, follow existing code style (Bootstrap 5.3, Liquid templates), and add zero runtime overhead on pages that don't use them.
|
|
730
770
|
|
|
731
771
|
---
|
|
732
772
|
|
|
@@ -745,6 +785,6 @@ Built with these amazing technologies:
|
|
|
745
785
|
|
|
746
786
|
**Built with ❤️ for the Jekyll community**
|
|
747
787
|
|
|
748
|
-
**v0.
|
|
788
|
+
**v0.21.6** • [Changelog](CHANGELOG.md) • [License](LICENSE) • [Contributing](CONTRIBUTING.md)
|
|
749
789
|
|
|
750
790
|
|
data/_data/authors.yml
CHANGED
|
@@ -25,12 +25,21 @@ default:
|
|
|
25
25
|
role: "Development Team"
|
|
26
26
|
|
|
27
27
|
bamr87:
|
|
28
|
-
name: "Amr
|
|
29
|
-
|
|
28
|
+
name: "Amr Abdel-Motaleb"
|
|
29
|
+
display_name: "Amr Abdel (bamr87)"
|
|
30
|
+
bio: "Creator of zer0-mistakes and the AIEO methodology. Developer, automation enthusiast, and Docker advocate building tools for the Jekyll community."
|
|
30
31
|
avatar: "/images/authors/bamr87.png"
|
|
31
32
|
github: "bamr87"
|
|
32
33
|
twitter: "bamr87"
|
|
33
|
-
|
|
34
|
+
linkedin: "bamr87"
|
|
35
|
+
website: "https://zer0-mistakes.com"
|
|
36
|
+
role: "Creator & Lead Developer"
|
|
37
|
+
expertise:
|
|
38
|
+
- "Jekyll theme development"
|
|
39
|
+
- "Docker containerization"
|
|
40
|
+
- "AI Engine Optimization (AIEO)"
|
|
41
|
+
- "GitHub Pages deployment"
|
|
42
|
+
- "Bootstrap UI frameworks"
|
|
34
43
|
|
|
35
44
|
guest:
|
|
36
45
|
name: "Guest Author"
|
data/_data/features.yml
CHANGED
|
@@ -205,7 +205,7 @@ features:
|
|
|
205
205
|
- "_includes/navigation/sidebar-right.html"
|
|
206
206
|
- "_includes/navigation/sidebar-categories.html"
|
|
207
207
|
- "_includes/navigation/sidebar-folders.html"
|
|
208
|
-
styles: ["_sass/core/_docs.scss", "_sass/custom.scss"]
|
|
208
|
+
styles: ["_sass/core/_docs-layout.scss", "_sass/custom.scss"]
|
|
209
209
|
docs: "docs/SIDEBAR_IMPROVEMENTS.md"
|
|
210
210
|
features:
|
|
211
211
|
- "Intersection Observer scroll spy"
|
data/_data/glossary.yml
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Glossary Data File
|
|
2
|
+
# ==================
|
|
3
|
+
# Key terms and definitions used throughout the zer0-mistakes theme.
|
|
4
|
+
# Used by: pages/glossary.md
|
|
5
|
+
#
|
|
6
|
+
# Fields:
|
|
7
|
+
# term: The term being defined (required)
|
|
8
|
+
# definition: A clear, concise definition (required)
|
|
9
|
+
# url: Link to learn more (optional)
|
|
10
|
+
# related: Related terms (optional)
|
|
11
|
+
|
|
12
|
+
- term: "Jekyll"
|
|
13
|
+
definition: "A static site generator written in Ruby that transforms plain text files (Markdown, Liquid templates) into a complete website. Jekyll is the engine behind GitHub Pages and powers zer0-mistakes."
|
|
14
|
+
url: "https://jekyllrb.com/"
|
|
15
|
+
related: ["Liquid", "GitHub Pages", "Ruby"]
|
|
16
|
+
|
|
17
|
+
- term: "Liquid"
|
|
18
|
+
definition: "An open-source template language created by Shopify and used by Jekyll. Liquid uses tags ({% %}), objects ({{ }}), and filters to render dynamic content in static HTML pages."
|
|
19
|
+
url: "https://shopify.github.io/liquid/"
|
|
20
|
+
related: ["Jekyll", "Includes"]
|
|
21
|
+
|
|
22
|
+
- term: "Bootstrap"
|
|
23
|
+
definition: "A front-end CSS and JavaScript framework for building responsive, mobile-first websites. zer0-mistakes uses Bootstrap 5.3.3 for its grid system, components, and utility classes."
|
|
24
|
+
url: "https://getbootstrap.com/"
|
|
25
|
+
related: ["Responsive Design", "SCSS"]
|
|
26
|
+
|
|
27
|
+
- term: "Docker"
|
|
28
|
+
definition: "A platform for developing, shipping, and running applications inside lightweight, portable containers. zer0-mistakes uses Docker as the primary development environment to ensure cross-platform consistency."
|
|
29
|
+
url: "https://www.docker.com/"
|
|
30
|
+
related: ["Docker Compose", "Docker-First"]
|
|
31
|
+
|
|
32
|
+
- term: "Docker Compose"
|
|
33
|
+
definition: "A tool for defining and running multi-container Docker applications using a YAML configuration file (docker-compose.yml). In zer0-mistakes, docker-compose up starts the full development environment."
|
|
34
|
+
url: "https://docs.docker.com/compose/"
|
|
35
|
+
related: ["Docker"]
|
|
36
|
+
|
|
37
|
+
- term: "Docker-First"
|
|
38
|
+
definition: "A development philosophy where Docker containers are the primary and recommended development environment. This ensures all developers get identical behavior regardless of their host operating system."
|
|
39
|
+
related: ["Docker", "Docker Compose"]
|
|
40
|
+
|
|
41
|
+
- term: "GitHub Pages"
|
|
42
|
+
definition: "A free static site hosting service from GitHub that builds Jekyll sites directly from a repository. zer0-mistakes is fully compatible with GitHub Pages using the remote_theme configuration."
|
|
43
|
+
url: "https://pages.github.com/"
|
|
44
|
+
related: ["Jekyll", "Remote Theme"]
|
|
45
|
+
|
|
46
|
+
- term: "Remote Theme"
|
|
47
|
+
definition: "A Jekyll configuration that loads a theme from a GitHub repository instead of installing it locally. Configured via remote_theme: bamr87/zer0-mistakes in _config.yml for GitHub Pages compatibility."
|
|
48
|
+
related: ["GitHub Pages", "Jekyll"]
|
|
49
|
+
|
|
50
|
+
- term: "Mermaid"
|
|
51
|
+
definition: "A JavaScript-based diagramming and charting library that renders Markdown-like text into diagrams (flowcharts, sequence diagrams, Gantt charts, etc.). Enabled per-page in zer0-mistakes with mermaid: true in front matter."
|
|
52
|
+
url: "https://mermaid.js.org/"
|
|
53
|
+
related: ["Markdown"]
|
|
54
|
+
|
|
55
|
+
- term: "MathJax"
|
|
56
|
+
definition: "A JavaScript display engine for mathematical notation (LaTeX, MathML, AsciiMath). Loaded asynchronously in zer0-mistakes for rendering equations in blog posts and documentation."
|
|
57
|
+
url: "https://www.mathjax.org/"
|
|
58
|
+
|
|
59
|
+
- term: "PostHog"
|
|
60
|
+
definition: "An open-source product analytics platform. zer0-mistakes integrates PostHog for privacy-compliant analytics with cookie consent, respecting Do Not Track settings and GDPR/CCPA requirements."
|
|
61
|
+
url: "https://posthog.com/"
|
|
62
|
+
related: ["Analytics", "Cookie Consent"]
|
|
63
|
+
|
|
64
|
+
- term: "Front Matter"
|
|
65
|
+
definition: "A YAML block at the top of Jekyll files (between --- delimiters) that defines metadata such as layout, title, date, tags, and custom variables. Front matter drives Jekyll's template rendering."
|
|
66
|
+
related: ["Jekyll", "YAML"]
|
|
67
|
+
|
|
68
|
+
- term: "SCSS"
|
|
69
|
+
definition: "Sassy CSS — a CSS preprocessor that adds variables, nesting, mixins, and other features to standard CSS. Jekyll compiles SCSS files from _sass/ into production CSS automatically."
|
|
70
|
+
related: ["Bootstrap", "CSS"]
|
|
71
|
+
|
|
72
|
+
- term: "Semantic Versioning"
|
|
73
|
+
definition: "A versioning scheme using MAJOR.MINOR.PATCH format where MAJOR indicates breaking changes, MINOR indicates new backward-compatible features, and PATCH indicates backward-compatible bug fixes. zer0-mistakes follows SemVer strictly."
|
|
74
|
+
url: "https://semver.org/"
|
|
75
|
+
related: ["CHANGELOG"]
|
|
76
|
+
|
|
77
|
+
- term: "AIEO"
|
|
78
|
+
definition: "AI Engine Optimization — a methodology for making web content maximally citable by AI systems. Includes structured data, entity density, E-E-A-T signals, FAQ injection, glossary definitions, and temporal anchoring."
|
|
79
|
+
related: ["JSON-LD", "E-E-A-T", "Structured Data"]
|
|
80
|
+
|
|
81
|
+
- term: "E-E-A-T"
|
|
82
|
+
definition: "Experience, Expertise, Authoritativeness, and Trustworthiness — quality signals used by search engines and AI systems to evaluate content credibility. zer0-mistakes implements E-E-A-T through author profiles, structured data, and cited claims."
|
|
83
|
+
related: ["AIEO", "Structured Data"]
|
|
84
|
+
|
|
85
|
+
- term: "JSON-LD"
|
|
86
|
+
definition: "JavaScript Object Notation for Linked Data — a method of encoding structured data in JSON format using Schema.org vocabulary. zer0-mistakes uses JSON-LD scripts in the HTML head for SoftwareApplication, FAQPage, and Person schemas."
|
|
87
|
+
url: "https://json-ld.org/"
|
|
88
|
+
related: ["Schema.org", "Structured Data", "AIEO"]
|
|
89
|
+
|
|
90
|
+
- term: "Schema.org"
|
|
91
|
+
definition: "A collaborative vocabulary for structured data markup on web pages. Schema.org types (SoftwareApplication, Person, FAQPage, etc.) help search engines and AI understand page content."
|
|
92
|
+
url: "https://schema.org/"
|
|
93
|
+
related: ["JSON-LD", "Structured Data"]
|
|
94
|
+
|
|
95
|
+
- term: "Cookie Consent"
|
|
96
|
+
definition: "A user-facing mechanism that requests permission before storing cookies or tracking data. zer0-mistakes includes a GDPR/CCPA-compliant cookie consent banner with granular preference management."
|
|
97
|
+
related: ["PostHog", "GDPR"]
|
|
98
|
+
|
|
99
|
+
- term: "SRI (Subresource Integrity)"
|
|
100
|
+
definition: "A security feature that lets browsers verify that resources fetched from CDNs have not been tampered with. zer0-mistakes uses SRI hashes on all CDN-loaded Bootstrap CSS and JS files."
|
|
101
|
+
related: ["Bootstrap", "CDN"]
|
data/_data/navigation/docs.yml
CHANGED
|
@@ -130,6 +130,18 @@
|
|
|
130
130
|
- title: Bootstrap Overview
|
|
131
131
|
url: /docs/bootstrap/
|
|
132
132
|
|
|
133
|
+
# ============================================================
|
|
134
|
+
# Development
|
|
135
|
+
# ============================================================
|
|
136
|
+
- title: Development
|
|
137
|
+
icon: bi-tools
|
|
138
|
+
url: /docs/development/testing/
|
|
139
|
+
children:
|
|
140
|
+
- title: Testing
|
|
141
|
+
url: /docs/development/testing/
|
|
142
|
+
- title: Vendor assets
|
|
143
|
+
url: /docs/development/vendor-assets/
|
|
144
|
+
|
|
133
145
|
# ============================================================
|
|
134
146
|
# Help
|
|
135
147
|
# ============================================================
|
data/_data/navigation/home.yml
CHANGED
data/_data/navigation/main.yml
CHANGED
|
@@ -48,14 +48,8 @@
|
|
|
48
48
|
children:
|
|
49
49
|
- title: All Notebooks
|
|
50
50
|
url: /notebooks/
|
|
51
|
-
- title:
|
|
52
|
-
url: /notebooks/
|
|
53
|
-
- title: Matplotlib Visualization
|
|
54
|
-
url: /notebooks/matplotlib-visualization/
|
|
55
|
-
- title: Python Statistics
|
|
56
|
-
url: /notebooks/python-statistics/
|
|
57
|
-
- title: API Requests
|
|
58
|
-
url: /notebooks/api-requests/
|
|
51
|
+
- title: Test Notebook
|
|
52
|
+
url: /notebooks/test-notebook/
|
|
59
53
|
|
|
60
54
|
- title: Docs
|
|
61
55
|
icon: bi-journal-bookmark
|