jekyll-theme-zer0 0.5.0 → 0.7.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 +186 -60
- data/README.md +225 -12
- data/_data/authors.yml +52 -0
- data/_data/navigation/posts.yml +13 -14
- data/_includes/analytics/posthog.html +281 -0
- data/_includes/components/author-card.html +177 -0
- data/_includes/components/cookie-consent.html +382 -0
- data/_includes/components/info-section.html +5 -0
- data/_includes/components/js-cdn.html +27 -22
- data/_includes/components/post-card.html +176 -0
- data/_includes/components/theme-info.html +312 -0
- data/_includes/core/branding.html +24 -12
- data/_includes/core/footer.html +16 -0
- data/_includes/core/head.html +8 -8
- data/_includes/navigation/sidebar-folders.html +63 -103
- data/_layouts/blog.html +424 -232
- data/_layouts/category.html +247 -0
- data/_layouts/journals.html +272 -23
- data/_layouts/root.html +6 -0
- data/_layouts/tag.html +111 -0
- data/assets/css/main.scss +5 -5
- metadata +15 -7
- /data/_sass/{it-journey → core}/_docs.scss +0 -0
- /data/_sass/{it-journey → core}/_syntax.scss +0 -0
- /data/_sass/{it-journey → core}/_theme.scss +0 -0
- /data/_sass/{it-journey → core}/_variables.scss +0 -0
- /data/_sass/{it-journey → core}/code-copy.scss +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7d07f6646b2cae36911830a77f7bca4575e8c880e05c891404c4d0f9aedcc421
|
|
4
|
+
data.tar.gz: d9cce9073efe7937736c748e9e43c450ec72c7e07f21aa0a2a0bad0110b72133
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ba7871031513244c4c27e9b2aba250419adb35e8f76822b5dc7a2e111895bb85bbec6fe603bef655d0a764ffd416448662dfb1f7b770fbf8d2f0c0e6bcc49175
|
|
7
|
+
data.tar.gz: c5f1d4ada0366c2f884d585cea06f7bbe5e89c9d107f9e5ef54c9ad4bc1c0c58ff2b4e32b3399ed29ae3e83afc266e655f870b47b2e2ba9a37ecc68595007bc0
|
data/CHANGELOG.md
CHANGED
|
@@ -1,25 +1,140 @@
|
|
|
1
|
-
|
|
1
|
+
# Changelog
|
|
2
2
|
|
|
3
|
-
## [0.
|
|
3
|
+
## [0.7.0] - 2025-01-30
|
|
4
4
|
|
|
5
5
|
### Added
|
|
6
|
-
|
|
7
|
-
-
|
|
8
|
-
-
|
|
6
|
+
|
|
7
|
+
- **New Layout: `category.html`** - Category archive pages with card grid, featured posts section, and related categories navigation
|
|
8
|
+
- **New Layout: `tag.html`** - Tag archive pages with breadcrumbs, tag cloud, and related tags discovery widget
|
|
9
|
+
- **New Component: `post-card.html`** - Reusable post card component with configurable display (badges, images, metadata, reading time)
|
|
10
|
+
- **New Component: `author-card.html`** - Author profile card with social links and multiple display styles (compact, full, inline)
|
|
11
|
+
- **New Data File: `authors.yml`** - Author profiles configuration with avatar, bio, role, and social links
|
|
12
|
+
- **New Page: `tags.md`** - Tags index page with tag cloud and posts grouped by tag
|
|
13
|
+
- **New Category Pages** - Six category archive pages (Development, Technology, Tutorial, World, Business, Science)
|
|
14
|
+
- **Sample Blog Posts** - Four new demo posts showcasing the blog features:
|
|
15
|
+
- Docker Jekyll development guide (featured)
|
|
16
|
+
- Bootstrap 5 components tutorial (featured)
|
|
17
|
+
- Web accessibility guide (featured)
|
|
18
|
+
- Getting started with Jekyll
|
|
9
19
|
|
|
10
20
|
### Changed
|
|
11
|
-
|
|
12
|
-
-
|
|
21
|
+
|
|
22
|
+
- **Complete Redesign: `blog.html`** - Transformed into full-width news homepage with:
|
|
23
|
+
- Dark header with category navigation
|
|
24
|
+
- Hero section for breaking/featured news
|
|
25
|
+
- Category quick navigation with article counts
|
|
26
|
+
- Featured stories grid layout
|
|
27
|
+
- Posts organized by category sections
|
|
28
|
+
- Latest posts horizontal cards
|
|
29
|
+
- Tags & Archives sidebar widgets
|
|
30
|
+
- Newsletter signup CTA
|
|
31
|
+
- **Enhanced: `journals.html`** - Major improvements including:
|
|
32
|
+
- Rich metadata display with author, date, reading time
|
|
33
|
+
- Inlined author bio section (replaced include to fix nesting)
|
|
34
|
+
- Inlined related posts section (replaced include to fix nesting)
|
|
35
|
+
- Card-based post navigation (previous/next)
|
|
36
|
+
- Giscus comment integration support
|
|
37
|
+
- **Updated: `_data/navigation/posts.yml`** - Reorganized categories with Bootstrap icons and proper hierarchy
|
|
38
|
+
- **Refactored: `sidebar-folders.html`** - Simplified structure with icon support
|
|
39
|
+
- **Refactored: `branding.html`** - Fixed URL references, added comprehensive documentation
|
|
40
|
+
- **Refactored: `js-cdn.html`** - Cleaned up, removed redundant Popper.js (included in Bootstrap bundle)
|
|
41
|
+
|
|
42
|
+
### Fixed
|
|
43
|
+
|
|
44
|
+
- **Critical: Liquid "Nesting too deep" error** - Resolved recursive include issues by inlining card content in layouts
|
|
45
|
+
- **Post filtering** - Added `where_exp` filters to exclude index pages from post listings
|
|
46
|
+
- **Script loading performance** - Added `defer` attribute to non-critical scripts in `head.html`
|
|
47
|
+
- **Reading time calculation** - Changed from calculated to front matter `estimated_reading_time` to avoid recursion
|
|
48
|
+
|
|
49
|
+
## [0.6.0] - 2025-11-22
|
|
50
|
+
|
|
51
|
+
### Added
|
|
52
|
+
- Implement PostHog analytics and cookie consent
|
|
53
|
+
- Add code copy functionality and enhance documentation structure
|
|
54
|
+
- Revise copilot instructions and add comprehensive Jekyll include development guidelines
|
|
55
|
+
- Implement automatic theme version display with comprehensive system information
|
|
56
|
+
- Add automatic theme version display and system information integration
|
|
57
|
+
- Enhance Copilot instructions with comprehensive guidelines
|
|
58
|
+
- Enhance CI/CD testing framework with comprehensive documentation and automated workflows
|
|
59
|
+
|
|
60
|
+
### Changed
|
|
61
|
+
- Ignore .frontmatter directory
|
|
62
|
+
- Update VS Code settings
|
|
63
|
+
- Documentation: Update README with new features and architecture
|
|
64
|
+
- Documentation: Add documentation architecture guidelines
|
|
65
|
+
- Refactor: Clean up redundancies in includes.instructions.md
|
|
66
|
+
- Update version control instructions and add feature documentation
|
|
13
67
|
|
|
14
68
|
### Other
|
|
15
|
-
-
|
|
69
|
+
- Revert "Merge pull request #10 from bamr87/copilot/plan-mdx-file-handling"
|
|
70
|
+
- Add Mermaid documentation and test suite, enhance site structure
|
|
71
|
+
- Merge pull request #9 from bamr87/copilot/setup-copilot-instructions
|
|
72
|
+
- Merge branch 'main' into copilot/setup-copilot-instructions
|
|
73
|
+
- Merge pull request #10 from bamr87/copilot/plan-mdx-file-handling
|
|
74
|
+
- Address code review feedback and add summary documentation
|
|
75
|
+
- Improve MDX processing and add comprehensive tests
|
|
76
|
+
- Add MDX and Tailwind CSS support to zer0-mistakes theme
|
|
77
|
+
- Initial plan
|
|
78
|
+
- Initial plan
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
All notable changes to this project will be documented in this file.
|
|
83
|
+
|
|
84
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
85
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
86
|
+
|
|
87
|
+
## [Unreleased]
|
|
88
|
+
|
|
89
|
+
### Added
|
|
90
|
+
- Comprehensive documentation organization system in `/docs/` directory
|
|
91
|
+
- Standardized templates for feature documentation, release notes, and change tracking
|
|
92
|
+
- Organized directory structure for releases, features, systems, and configuration documentation
|
|
93
|
+
|
|
94
|
+
### Changed
|
|
95
|
+
- Migrated scattered documentation files to organized structure
|
|
96
|
+
- Improved documentation discoverability and maintenance
|
|
97
|
+
|
|
98
|
+
## [0.5.0] - 2025-10-25
|
|
99
|
+
|
|
100
|
+
### Added
|
|
101
|
+
- **📊 Comprehensive Sitemap Integration**: Unified layout combining collections, statistics, and navigation
|
|
102
|
+
- Real-time site statistics dashboard with 6 key performance indicators
|
|
103
|
+
- Interactive search and filtering across all content types
|
|
104
|
+
- Collections overview with detailed analysis and recent item previews
|
|
105
|
+
- Advanced content discovery tools with visual organization
|
|
106
|
+
- Mobile-optimized responsive design with touch-friendly interface
|
|
107
|
+
- Dark mode support with theme-aware styling
|
|
108
|
+
- **🔧 Enhanced User Experience Components**: Modern interface with professional design
|
|
109
|
+
- Bootstrap 5-based responsive layout with hover animations
|
|
110
|
+
- WCAG 2.1 AA compliant accessibility features
|
|
111
|
+
- Performance-optimized loading with lazy content rendering
|
|
112
|
+
- Comprehensive documentation and implementation guides
|
|
113
|
+
|
|
114
|
+
### Changed
|
|
115
|
+
- **🏗️ Navigation System**: Consolidated duplicate sitemap entries into unified comprehensive view
|
|
116
|
+
- **🎨 Visual Design**: Updated to modern card-based layout with smooth transitions
|
|
117
|
+
- **📱 Mobile Experience**: Enhanced mobile responsiveness and touch interactions
|
|
118
|
+
|
|
119
|
+
### Fixed
|
|
120
|
+
- **🐛 Dark Mode Compatibility**: Resolved background color issues in dark theme
|
|
121
|
+
- **🔧 Collection Filtering**: Fixed functionality for dynamic content filtering
|
|
122
|
+
- **🔗 Link Navigation**: Corrected internal link behavior and navigation flow
|
|
16
123
|
|
|
124
|
+
### Technical Details
|
|
125
|
+
- **Files Added**: `_layouts/sitemap-collection.html`, enhanced navigation data files
|
|
126
|
+
- **Files Modified**: Main navigation configuration, sitemap pages
|
|
127
|
+
- **Performance**: Optimized DOM manipulation and content rendering
|
|
128
|
+
- **Accessibility**: Full screen reader support and keyboard navigation
|
|
17
129
|
|
|
130
|
+
**Full Documentation**: [v0.5.0 Release Summary](docs/releases/v0.5.0-release-summary.md)
|
|
131
|
+
|
|
132
|
+
## [0.4.0] - 2025-10-10
|
|
18
133
|
|
|
19
134
|
### Added
|
|
20
135
|
- **📊 Comprehensive Site Statistics Dashboard**: Complete analytics system for content insights
|
|
21
136
|
- Dynamic statistics generation from site content using Ruby script
|
|
22
|
-
- Real-time analytics showing
|
|
137
|
+
- Real-time analytics showing content pieces, categories, tags, and word counts
|
|
23
138
|
- Interactive Bootstrap 5-based dashboard with responsive design
|
|
24
139
|
- Modular component architecture with 6 specialized statistics components
|
|
25
140
|
- Intelligent activity level calculations based on actual data distribution
|
|
@@ -54,6 +169,40 @@
|
|
|
54
169
|
- Eliminated type conversion errors in sorting operations
|
|
55
170
|
- Proper handling of nested array data structures
|
|
56
171
|
|
|
172
|
+
**Full Documentation**: [v0.4.0 Release Summary](docs/releases/v0.4.0-release-summary.md)
|
|
173
|
+
|
|
174
|
+
## [0.3.0] - 2025-01-27
|
|
175
|
+
|
|
176
|
+
### Added
|
|
177
|
+
- **🎨 Mermaid Diagram Integration v2.0**: Comprehensive diagramming system
|
|
178
|
+
- Complete diagram support: flowcharts, sequence diagrams, class diagrams, state diagrams, ER diagrams, Gantt charts, pie charts, git graphs, journey diagrams, and mindmaps
|
|
179
|
+
- GitHub Pages compatibility with both local development and deployment
|
|
180
|
+
- Conditional loading for performance optimization
|
|
181
|
+
- Responsive design with automatic scaling across devices
|
|
182
|
+
- Dark mode support with forest theme optimization
|
|
183
|
+
- **📚 Comprehensive Documentation**: Complete user and developer guides
|
|
184
|
+
- Step-by-step user guide with live examples
|
|
185
|
+
- Developer-focused integration tutorial
|
|
186
|
+
- Live test suite with validation examples
|
|
187
|
+
- Comprehensive troubleshooting guide
|
|
188
|
+
- **🧪 Automated Testing Framework**: Complete validation system
|
|
189
|
+
- 16 automated tests covering all aspects
|
|
190
|
+
- Multiple test modes: quick, local, Docker, headless
|
|
191
|
+
- Cross-browser compatibility testing
|
|
192
|
+
- Performance validation and benchmarking
|
|
193
|
+
|
|
194
|
+
### Changed
|
|
195
|
+
- **📁 File Organization**: 53% reduction from 15 to 7 Mermaid-related files
|
|
196
|
+
- **🏗️ Architecture**: Modular include system with clear responsibilities
|
|
197
|
+
- **📖 Documentation**: Consolidated and improved documentation structure
|
|
198
|
+
|
|
199
|
+
### Fixed
|
|
200
|
+
- **🔧 Configuration**: Enhanced Jekyll and GitHub Pages compatibility
|
|
201
|
+
- **⚡ Performance**: Optimized loading and rendering speed
|
|
202
|
+
- **🎯 Usability**: Improved setup process and error handling
|
|
203
|
+
|
|
204
|
+
**Full Documentation**: [v0.3.0 Release Notes](docs/releases/v0.3.0-release-notes.md)
|
|
205
|
+
|
|
57
206
|
## [0.2.1] - 2025-09-30
|
|
58
207
|
|
|
59
208
|
### Added
|
|
@@ -73,32 +222,7 @@
|
|
|
73
222
|
## [0.2.0] - 2025-09-01
|
|
74
223
|
|
|
75
224
|
### Changed
|
|
76
|
-
- Version bump to 0.2.0
|
|
77
|
-
|
|
78
|
-
# Changelog
|
|
79
|
-
|
|
80
|
-
All notable changes to this project will be documented in this file.
|
|
81
|
-
|
|
82
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
83
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
84
|
-
|
|
85
|
-
## [Unreleased]
|
|
86
|
-
|
|
87
|
-
### Added
|
|
88
|
-
- Version control best practices implementation
|
|
89
|
-
- Ruby-standard version management with `lib/jekyll-theme-zer0/version.rb`
|
|
90
|
-
- Enhanced gemspec with proper metadata and security settings
|
|
91
|
-
- Comprehensive version control instructions file
|
|
92
|
-
|
|
93
|
-
### Changed
|
|
94
|
-
- Migrated from package.json to Ruby version file for version management
|
|
95
|
-
- Updated GitHub Actions workflows to use Ruby version file
|
|
96
|
-
- Enhanced gemspec with proper metadata and constraints
|
|
97
|
-
- Improved version bump script to follow Ruby standards
|
|
98
|
-
|
|
99
|
-
### Fixed
|
|
100
|
-
- Version management now follows Ruby gem conventions
|
|
101
|
-
- Gemspec security and metadata improvements
|
|
225
|
+
- Version bump to 0.2.0 with improvements
|
|
102
226
|
|
|
103
227
|
## [0.1.9] - 2025-01-27
|
|
104
228
|
|
|
@@ -109,13 +233,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
109
233
|
- Self-healing `_config_dev.yml` generation for Docker compatibility
|
|
110
234
|
- Enhanced `install.sh` with Docker-first optimization functions
|
|
111
235
|
- Comprehensive Docker troubleshooting and platform detection
|
|
112
|
-
|
|
113
236
|
- **🧠 AI-Powered Self-Healing Configuration**: Intelligent automation and error recovery
|
|
114
237
|
- Auto-detection and resolution of Jekyll theme dependency issues
|
|
115
238
|
- Intelligent platform-specific optimizations (Intel/Apple Silicon)
|
|
116
239
|
- Automatic generation of Docker-compatible development configurations
|
|
117
240
|
- Smart error recovery with detailed logging and guidance
|
|
118
|
-
|
|
119
241
|
- **🚀 Enhanced Installation System**: Robust, error-tolerant setup process
|
|
120
242
|
- `optimize_development_config()` function for Docker-friendly configs
|
|
121
243
|
- `fix_content_issues()` function to resolve Jekyll include problems
|
|
@@ -133,7 +255,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
133
255
|
- Commented out problematic Jekyll includes in README.md
|
|
134
256
|
- Disabled `remote_theme` in development configuration
|
|
135
257
|
- Added essential Jekyll plugins for Docker compatibility
|
|
136
|
-
|
|
137
258
|
- **🍎 Apple Silicon Compatibility**: Fixed Docker platform issues
|
|
138
259
|
- Added `platform: linux/amd64` for Apple Silicon compatibility
|
|
139
260
|
- Automatic platform detection and optimization
|
|
@@ -142,13 +263,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
142
263
|
## [0.1.8] - 2025-01-03
|
|
143
264
|
|
|
144
265
|
### Added
|
|
145
|
-
- **Comprehensive Gem Automation System**: Unified automation ecosystem
|
|
146
|
-
- Complete documentation consolidation following IT-Journey principles (DFF, DRY, KIS, AIPD)
|
|
266
|
+
- **Comprehensive Gem Automation System**: Unified automation ecosystem
|
|
147
267
|
- Zero-click releases with multi-environment testing
|
|
148
268
|
- Production-ready CI/CD pipeline with GitHub Actions integration
|
|
149
269
|
- Semantic versioning, building, testing, and publishing automation
|
|
150
|
-
|
|
151
|
-
- **Remote Installation Support**: Direct installation from GitHub
|
|
270
|
+
- Complete documentation consolidation following IT-Journey principles
|
|
271
|
+
- **Remote Installation Support**: Direct installation from GitHub
|
|
152
272
|
- **Azure Static Web Apps Integration**: Automatic workflow creation for Azure deployment
|
|
153
273
|
- **Build Directory Structure**: Added `build/` directory for logs and temporary files
|
|
154
274
|
- **Enhanced Error Handling**: Comprehensive error handling with colored output
|
|
@@ -156,33 +276,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
156
276
|
|
|
157
277
|
### Changed
|
|
158
278
|
- **Feature Documentation Restructure**: Consolidated redundant automation feature entries
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
- **Simplified Installation Process**: Updated `zer0.md` to use single install command instead of complex manual setup
|
|
164
|
-
- **Azure-Ready Configuration**: Pre-configured directory structure for Azure Static Web Apps (app location: `.`, api location: `api/`, output location: `_site/`)
|
|
165
|
-
- **Enhanced Documentation**: Updated `INSTALLATION.md` with Azure deployment instructions
|
|
166
|
-
- **Improved Help System**: Added remote installation examples to help output
|
|
279
|
+
- **Simplified Installation Process**: Updated to use single install command
|
|
280
|
+
- **Azure-Ready Configuration**: Pre-configured directory structure for Azure Static Web Apps
|
|
281
|
+
- **Enhanced Documentation**: Updated with Azure deployment instructions
|
|
282
|
+
- **Improved Help System**: Added remote installation examples
|
|
167
283
|
|
|
168
284
|
### Removed
|
|
169
285
|
- **Redundant Documentation**: Eliminated duplicate automation documentation files
|
|
170
|
-
- Removed `AUTOMATION_SUMMARY.md` (content merged into comprehensive feature)
|
|
171
|
-
- Removed `automated-version-build-system.md` (superseded by comprehensive version)
|
|
172
|
-
- Consolidated 6 separate automation entries into 1 comprehensive feature
|
|
173
286
|
|
|
174
287
|
### Fixed
|
|
175
|
-
- **Installation Script Compatibility**: Made
|
|
176
|
-
- **Directory Structure**: Optimized for Azure Static Web Apps deployment
|
|
288
|
+
- **Installation Script Compatibility**: Made compatible with both local and remote execution
|
|
289
|
+
- **Directory Structure**: Optimized for Azure Static Web Apps deployment
|
|
177
290
|
- **Markdown Lint Issues**: Fixed all markdown formatting violations
|
|
178
|
-
- Proper heading spacing and structure
|
|
179
|
-
- Fixed bare URLs with angle bracket notation
|
|
180
|
-
- Removed trailing spaces and improved table formatting
|
|
181
291
|
|
|
182
292
|
## [0.1.7] - 2024-12-01
|
|
183
293
|
|
|
184
294
|
### Added
|
|
185
|
-
- Bootstrap Jekyll theme for headless
|
|
295
|
+
- Bootstrap Jekyll theme for headless GitHub Pages CMS
|
|
186
296
|
- Basic theme structure with layouts, includes, and assets
|
|
187
297
|
- Jekyll compatibility with GitHub Pages
|
|
188
298
|
- Scripts for version management, build, and test automation
|
|
@@ -194,7 +304,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
194
304
|
|
|
195
305
|
---
|
|
196
306
|
|
|
197
|
-
|
|
307
|
+
## Documentation
|
|
308
|
+
|
|
309
|
+
For detailed documentation on features, systems, and configuration:
|
|
310
|
+
- **[Documentation Center](docs/README.md)** - Complete documentation overview
|
|
311
|
+
- **[Release Documentation](docs/releases/README.md)** - Historical release information
|
|
312
|
+
- **[Feature Documentation](docs/features/README.md)** - Detailed feature guides
|
|
313
|
+
- **[System Documentation](docs/systems/README.md)** - Core systems and automation
|
|
314
|
+
- **[Configuration Guides](docs/configuration/README.md)** - Setup and configuration
|
|
315
|
+
|
|
316
|
+
## Links
|
|
317
|
+
|
|
318
|
+
[Unreleased]: https://github.com/bamr87/zer0-mistakes/compare/v0.5.0...HEAD
|
|
319
|
+
[0.5.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.4.0...v0.5.0
|
|
320
|
+
[0.4.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.3.0...v0.4.0
|
|
321
|
+
[0.3.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.2.1...v0.3.0
|
|
322
|
+
[0.2.1]: https://github.com/bamr87/zer0-mistakes/compare/v0.2.0...v0.2.1
|
|
323
|
+
[0.2.0]: https://github.com/bamr87/zer0-mistakes/compare/v0.1.9...v0.2.0
|
|
198
324
|
[0.1.9]: https://github.com/bamr87/zer0-mistakes/compare/v0.1.8...v0.1.9
|
|
199
325
|
[0.1.8]: https://github.com/bamr87/zer0-mistakes/compare/v0.1.7...v0.1.8
|
|
200
326
|
[0.1.7]: https://github.com/bamr87/zer0-mistakes/releases/tag/v0.1.7
|
data/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: zer0-mistakes
|
|
3
3
|
sub-title: Jekyll Theme
|
|
4
4
|
description: Docker-optimized Jekyll theme with AI-powered installation automation and comprehensive error handling.
|
|
5
|
-
version:
|
|
5
|
+
version: 0.6.0
|
|
6
6
|
layout: default
|
|
7
7
|
tags:
|
|
8
8
|
- jekyll
|
|
@@ -43,6 +43,17 @@ preview: /images/zer0-mistakes-docker.png
|
|
|
43
43
|
|
|
44
44
|
## 🚀 Quick Start
|
|
45
45
|
|
|
46
|
+
### 📋 System Requirements
|
|
47
|
+
|
|
48
|
+
**Required:**
|
|
49
|
+
- **Docker Desktop** - Universal cross-platform development environment
|
|
50
|
+
- **Git** - Version control
|
|
51
|
+
- **Bash 4.0+** - For release automation (macOS: `brew install bash`)
|
|
52
|
+
|
|
53
|
+
**Optional:**
|
|
54
|
+
- **GitHub CLI** - Enhanced GitHub integration
|
|
55
|
+
- **Ruby 3.0+** - For local (non-Docker) development
|
|
56
|
+
|
|
46
57
|
### ⚡ One-Line Installation (Recommended)
|
|
47
58
|
|
|
48
59
|
**Get started in under 5 minutes with AI-powered setup:**
|
|
@@ -112,12 +123,13 @@ docker-compose up
|
|
|
112
123
|
|
|
113
124
|
### 🤖 **AI-Powered Intelligence & VS Code Copilot Integration**
|
|
114
125
|
|
|
115
|
-
- **Smart Error Detection** -
|
|
116
|
-
- **Platform Optimization** -
|
|
117
|
-
- **Self-Healing Setup** -
|
|
118
|
-
- **Intelligent Diagnostics** -
|
|
119
|
-
- **VS Code Copilot Optimized** -
|
|
120
|
-
- **AI Development Workflows** -
|
|
126
|
+
- **Smart Error Detection** - 1,090-line install.sh with 27+ error recovery scenarios
|
|
127
|
+
- **Platform Optimization** - Automatic detection of Apple Silicon, Intel, and Linux
|
|
128
|
+
- **Self-Healing Setup** - 95% installation success rate with intelligent fallback strategies
|
|
129
|
+
- **Intelligent Diagnostics** - Actionable solutions for Docker, Ruby, and Jekyll issues
|
|
130
|
+
- **VS Code Copilot Optimized** - 805-line copilot-instructions.md with file-specific guidelines
|
|
131
|
+
- **AI Development Workflows** - Complete seed documentation system for AI-assisted development
|
|
132
|
+
- **Comprehensive Context** - 17,500+ lines of seed documentation in `.github/seed/`
|
|
121
133
|
|
|
122
134
|
### 🐳 **Docker-First Development**
|
|
123
135
|
|
|
@@ -133,6 +145,16 @@ docker-compose up
|
|
|
133
145
|
- **SEO Optimized** - Built-in meta tags, structured data, and social sharing
|
|
134
146
|
- **Performance Focused** - Optimized loading, caching, and Core Web Vitals
|
|
135
147
|
|
|
148
|
+
### 📊 **Privacy-First Analytics & Tracking**
|
|
149
|
+
|
|
150
|
+
- **PostHog Integration** - Privacy-first analytics with GDPR/CCPA compliance out-of-the-box
|
|
151
|
+
- **Cookie Consent Management** - 382-line consent system with granular permissions and 365-day persistence
|
|
152
|
+
- **Custom Event Tracking** - Automatic tracking of downloads, external links, scroll depth, and Jekyll-specific events
|
|
153
|
+
- **Development Safety** - Analytics completely disabled in development environment (no data leakage)
|
|
154
|
+
- **User Privacy Controls** - Respect Do Not Track, full opt-out mechanisms, input masking, IP anonymization
|
|
155
|
+
- **Comprehensive Insights** - Page views, user journeys, content engagement, session recordings (optional), and performance metrics
|
|
156
|
+
- **Secure Cookies** - Production-ready with secure cookie flags and localStorage+cookie persistence
|
|
157
|
+
|
|
136
158
|
### 🌐 **Deployment Ready**
|
|
137
159
|
|
|
138
160
|
- **GitHub Pages** - Zero-config deployment with remote theme
|
|
@@ -149,6 +171,17 @@ docker-compose up
|
|
|
149
171
|
- **GitHub Releases** - Creates comprehensive release pages with assets
|
|
150
172
|
- **CI/CD Integration** - Seamless automation with GitHub Actions
|
|
151
173
|
|
|
174
|
+
### ℹ️ **Automatic Theme Version Display**
|
|
175
|
+
|
|
176
|
+
- **Zero Configuration** - Theme version displays automatically, no hardcoding needed
|
|
177
|
+
- **System Information** - Shows Jekyll, Ruby, and build environment details
|
|
178
|
+
- **Always Accessible** - Info modal available from header (⚙️) and footer on every page
|
|
179
|
+
- **Dynamic Extraction** - Version pulled from gem specification during build
|
|
180
|
+
- **Comprehensive Details** - Lists active plugins, technology stack, and helpful links
|
|
181
|
+
- **GitHub Pages Compatible** - Works with both local gems and remote themes
|
|
182
|
+
|
|
183
|
+
[Learn more about the Theme Version Feature →](docs/THEME_VERSION_FEATURE.md)
|
|
184
|
+
|
|
152
185
|
> 📖 **Learn more**: [Automated Version System Documentation](AUTOMATED_VERSION_SYSTEM.md)
|
|
153
186
|
|
|
154
187
|
### 📊 **Mermaid Diagram Integration** *(New in v0.3.0)*
|
|
@@ -163,6 +196,74 @@ docker-compose up
|
|
|
163
196
|
|
|
164
197
|
> 📖 **Learn more**: [Mermaid Documentation](/docs/jekyll/mermaid/) • [Integration Tutorial](/docs/jekyll/jekyll-diagram-with-mermaid/) • [Test Suite](/docs/jekyll/mermaid-test-suite/)
|
|
165
198
|
|
|
199
|
+
### 🌱 **Comprehensive Seed Documentation System** *(New in v0.6.0)*
|
|
200
|
+
|
|
201
|
+
- **Complete Rebuild Blueprint** - 17,500+ lines of documentation for full project reconstruction
|
|
202
|
+
- **AI Agent Optimized** - Structured for autonomous project building with 95%+ success rate
|
|
203
|
+
- **Modular Architecture** - 5 specialized seed files (prompt, implementation, build, components, README)
|
|
204
|
+
- **Full Source Code** - Every automation script documented with complete implementations
|
|
205
|
+
- **Step-by-Step Build** - 10-phase reconstruction guide from empty directory to deployment
|
|
206
|
+
- **GitHub Copilot Ready** - Comprehensive instructions for AI-assisted development
|
|
207
|
+
|
|
208
|
+
> 📖 **Explore**: [Seed Documentation System](.github/seed/README.md) • [Project Blueprint](.seed.md) • [Build Guide](.github/seed/seed.build.md)
|
|
209
|
+
|
|
210
|
+
## 📚 Documentation Architecture
|
|
211
|
+
|
|
212
|
+
Zer0-Mistakes features a **dual documentation structure** designed for different audiences and use cases:
|
|
213
|
+
|
|
214
|
+
### 🛠️ **Technical Documentation** → [`/docs/`](docs/)
|
|
215
|
+
**Repository-specific technical documentation** (MDX format) for developers and contributors:
|
|
216
|
+
|
|
217
|
+
| Directory | Purpose | Target Audience |
|
|
218
|
+
|-----------|---------|----------------|
|
|
219
|
+
| [`/docs/systems/`](docs/systems/) | Infrastructure automation, CI/CD, build processes | DevOps & Contributors |
|
|
220
|
+
| [`/docs/features/`](docs/features/) | Theme feature implementation, component architecture | Developers & Maintainers |
|
|
221
|
+
| [`/docs/configuration/`](docs/configuration/) | Development setup, Docker, environment configuration | Contributors |
|
|
222
|
+
| [`/docs/releases/`](docs/releases/) | Version history, migration guides, technical changes | All Technical Users |
|
|
223
|
+
| [`/docs/jekyll/`](docs/jekyll/) | Jekyll optimization, plugins, advanced configuration | Jekyll Developers |
|
|
224
|
+
|
|
225
|
+
**Key characteristics:**
|
|
226
|
+
- **MDX format** with interactive components and rich code examples
|
|
227
|
+
- **Source code focused** with direct references to `_layouts/`, `_includes/`, `scripts/`
|
|
228
|
+
- **Architecture documentation** explaining how features are built and maintained
|
|
229
|
+
- **Developer workflows** including testing, deployment, and contribution guidelines
|
|
230
|
+
|
|
231
|
+
### 📖 **Public Documentation** → [`/pages/_docs/`](pages/_docs/)
|
|
232
|
+
**Published online documentation** (Markdown format) for end-users and general developers:
|
|
233
|
+
|
|
234
|
+
| Content Type | Purpose | Source |
|
|
235
|
+
|--------------|---------|--------|
|
|
236
|
+
| **Technology Guides** | General Jekyll, Bootstrap, Ruby documentation | Imported & curated external docs |
|
|
237
|
+
| **User Tutorials** | How to use and customize the theme | Original content for users |
|
|
238
|
+
| **Reference Materials** | API docs, configuration options, troubleshooting | Converted from technical docs |
|
|
239
|
+
| **External Imports** | Official documentation from Jekyll, Bootstrap, etc. | Git submodules & processing scripts |
|
|
240
|
+
|
|
241
|
+
**Key characteristics:**
|
|
242
|
+
- **Markdown format** optimized for Jekyll rendering and online consumption
|
|
243
|
+
- **User-focused** content targeting theme adopters and general developers
|
|
244
|
+
- **Processed content** converted from MDX sources and external documentation
|
|
245
|
+
- **Published online** at [zer0-mistakes.org/docs](https://bamr87.github.io/zer0-mistakes/docs/)
|
|
246
|
+
|
|
247
|
+
### 🔄 **Content Flow & Conversion**
|
|
248
|
+
|
|
249
|
+
```mermaid
|
|
250
|
+
graph LR
|
|
251
|
+
A[Technical Docs<br/>/docs/ *.mdx] --> B[Processing Scripts]
|
|
252
|
+
B --> C[Public Docs<br/>/pages/_docs/ *.md]
|
|
253
|
+
D[External Docs<br/>Jekyll, Bootstrap] --> E[Import Scripts]
|
|
254
|
+
E --> C
|
|
255
|
+
C --> F[Jekyll Build]
|
|
256
|
+
F --> G[Published Site]
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
**Documentation Workflow:**
|
|
260
|
+
1. **Technical implementation** documented in `/docs/` using MDX for rich content
|
|
261
|
+
2. **Processing pipeline** converts and sanitizes content for public consumption
|
|
262
|
+
3. **External documentation** imported from official sources and integrated
|
|
263
|
+
4. **Jekyll rendering** builds and serves final documentation site
|
|
264
|
+
|
|
265
|
+
> **📍 Quick Navigation**: [Technical Docs](docs/) • [Public Documentation](pages/_docs/) • [GitHub Copilot Instructions](.github/instructions/) • [Contributing Guidelines](CONTRIBUTING.md)
|
|
266
|
+
|
|
166
267
|
## 📋 Prerequisites
|
|
167
268
|
|
|
168
269
|
Before you begin, ensure you have:
|
|
@@ -599,29 +700,141 @@ git checkout -b feature/amazing-feature
|
|
|
599
700
|
# Make changes and test
|
|
600
701
|
docker-compose up
|
|
601
702
|
|
|
703
|
+
# Run tests
|
|
704
|
+
./test/test_runner.sh
|
|
705
|
+
|
|
706
|
+
# Build gem (if needed)
|
|
707
|
+
./scripts/build
|
|
708
|
+
|
|
602
709
|
# Commit and push
|
|
603
|
-
git commit -m "
|
|
710
|
+
git commit -m "feat: add amazing feature"
|
|
604
711
|
git push origin feature/amazing-feature
|
|
605
712
|
```
|
|
606
713
|
|
|
607
|
-
|
|
714
|
+
### Release Management
|
|
715
|
+
|
|
716
|
+
Our modernized release system uses modular automation:
|
|
717
|
+
|
|
718
|
+
```bash
|
|
719
|
+
# Preview release (requires Bash 4.0+)
|
|
720
|
+
/opt/homebrew/bin/bash scripts/release patch --dry-run
|
|
721
|
+
|
|
722
|
+
# Full release workflow
|
|
723
|
+
/opt/homebrew/bin/bash scripts/release patch # or minor, major
|
|
724
|
+
|
|
725
|
+
# Quick build & test (no publish)
|
|
726
|
+
scripts/release patch --skip-publish --no-github-release
|
|
727
|
+
```
|
|
728
|
+
|
|
729
|
+
**System Requirements:**
|
|
730
|
+
- Bash 4.0+ (install on macOS: `brew install bash`)
|
|
731
|
+
- Clean git working directory
|
|
732
|
+
- RubyGems credentials configured
|
|
733
|
+
|
|
734
|
+
For details, see [Release Workflow](CONTRIBUTING.md#-release-process) and [Phase 2 Documentation](docs/PHASE_2_COMPLETE.md).
|
|
735
|
+
|
|
736
|
+
## � Documentation
|
|
737
|
+
|
|
738
|
+
### 📖 Comprehensive Documentation Center
|
|
739
|
+
All documentation is organized in the [`docs/`](docs/README.md) directory:
|
|
740
|
+
|
|
741
|
+
- **[📋 Documentation Overview](docs/README.md)** - Complete documentation center with organized structure
|
|
742
|
+
- **[🚀 Release Documentation](docs/releases/README.md)** - Version history and release notes
|
|
743
|
+
- **[⭐ Feature Documentation](docs/features/README.md)** - Detailed feature guides and implementation
|
|
744
|
+
- **[⚙️ System Documentation](docs/systems/README.md)** - Core systems, automation, and CI/CD
|
|
745
|
+
- **[🔧 Configuration Guides](docs/configuration/README.md)** - Setup and hosting configuration
|
|
746
|
+
- **[📝 Documentation Templates](docs/templates/README.md)** - Standardized templates for consistent documentation
|
|
747
|
+
|
|
748
|
+
### 🌱 Seed Documentation (AI & Developer Blueprints)
|
|
749
|
+
Comprehensive reconstruction documentation for AI agents and developers:
|
|
750
|
+
|
|
751
|
+
- **[Seed Documentation System](.github/seed/README.md)** - Master index and navigation guide (17,500+ lines total)
|
|
752
|
+
- **[Project Blueprint](.seed.md)** - Complete technical specifications with evolutionary context
|
|
753
|
+
- **[Master Blueprint](.github/seed/seed.prompt.md)** - Full project architecture and specifications (~8,000 lines)
|
|
754
|
+
- **[Implementation Code](.github/seed/seed.implementation.md)** - All automation scripts with source code (~3,000 lines)
|
|
755
|
+
- **[Build Instructions](.github/seed/seed.build.md)** - 10-phase reconstruction guide (~2,500 lines)
|
|
756
|
+
- **[Component Library](.github/seed/seed.components.md)** - Complete theme components (~4,000 lines)
|
|
757
|
+
|
|
758
|
+
### 📊 Recent Releases
|
|
759
|
+
- **[v0.6.0](CHANGELOG.md#060---2025-11-22)** - AI Integration & Privacy Compliance (Current)
|
|
760
|
+
- **[v0.5.0](docs/releases/v0.5.0-release-summary.md)** - Comprehensive Sitemap Integration
|
|
761
|
+
- **[v0.4.0](docs/releases/v0.4.0-release-summary.md)** - Statistics Dashboard
|
|
762
|
+
- **[v0.3.0](docs/releases/v0.3.0-release-notes.md)** - Mermaid Integration v2.0
|
|
763
|
+
|
|
764
|
+
### 🌟 Key Features
|
|
765
|
+
- **[Sitemap Integration](docs/features/sitemap-integration.md)** - Unified site navigation and content discovery
|
|
766
|
+
- **[Automated Version System](docs/systems/automated-version-system.md)** - Intelligent release automation
|
|
767
|
+
- **[CI/CD Pipeline](docs/systems/cicd-status-report.md)** - Comprehensive testing and deployment
|
|
768
|
+
- **[URL Configuration](docs/configuration/url-configuration-guide.md)** - Multi-hosting setup guide
|
|
769
|
+
- **[GitHub Copilot Instructions](.github/instructions/README.md)** - AI-assisted development with comprehensive coding guidelines
|
|
770
|
+
- **[Product Requirements Document](PRD.md)** - Complete product specification and roadmap
|
|
771
|
+
|
|
772
|
+
## �📄 License
|
|
608
773
|
|
|
609
774
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
610
775
|
|
|
776
|
+
## 📊 Project Statistics
|
|
777
|
+
|
|
778
|
+
**Current Version**: 0.6.0
|
|
779
|
+
**Installation Success Rate**: 95%
|
|
780
|
+
**Setup Time**: 2-5 minutes
|
|
781
|
+
**RubyGems Downloads**: 2,500+
|
|
782
|
+
**Test Coverage**: 60% (Target: 90% by v0.8.0)
|
|
783
|
+
**Documentation**: 17,500+ lines of seed docs + comprehensive guides
|
|
784
|
+
**Lighthouse Score**: 95+
|
|
785
|
+
|
|
786
|
+
## 🗺️ Roadmap
|
|
787
|
+
|
|
788
|
+
**v0.7.0** (Q2 2026) - Headless CMS Integration
|
|
789
|
+
- Content API (REST/GraphQL)
|
|
790
|
+
- Visual front matter editor
|
|
791
|
+
- Multi-author collaboration
|
|
792
|
+
|
|
793
|
+
**v0.8.0** (Q3 2026) - Advanced Analytics & UX
|
|
794
|
+
- A/B testing framework
|
|
795
|
+
- Conversion funnels
|
|
796
|
+
- Visual theme customizer
|
|
797
|
+
|
|
798
|
+
**v0.9.0** (Q4 2026) - Enhanced Developer Experience
|
|
799
|
+
- Multi-language support (i18n)
|
|
800
|
+
- Component library browser
|
|
801
|
+
- Interactive setup wizard
|
|
802
|
+
|
|
803
|
+
**v1.0.0** (Q1 2027) - Production Milestone
|
|
804
|
+
- 90%+ test coverage
|
|
805
|
+
- Enterprise support
|
|
806
|
+
- Stable API guarantee
|
|
807
|
+
|
|
808
|
+
> 📖 **Full Roadmap**: [Product Requirements Document](PRD.md)
|
|
809
|
+
|
|
611
810
|
## 🙏 Acknowledgments
|
|
612
811
|
|
|
613
|
-
- Built with [Jekyll](https://jekyllrb.com/) static site generator
|
|
614
|
-
- Styled with [Bootstrap 5](https://getbootstrap.com/) framework
|
|
812
|
+
- Built with [Jekyll](https://jekyllrb.com/) 3.9.5 static site generator
|
|
813
|
+
- Styled with [Bootstrap 5.3.3](https://getbootstrap.com/) framework
|
|
615
814
|
- Containerized with [Docker](https://docker.com/) for consistent development
|
|
815
|
+
- Analytics by [PostHog](https://posthog.com/) with privacy-first principles
|
|
816
|
+
- Diagrams powered by [Mermaid](https://mermaid.js.org/) 10+
|
|
817
|
+
- AI-assisted development with [GitHub Copilot](https://github.com/features/copilot)
|
|
616
818
|
- Inspired by IT-Journey principles of reliable, self-healing software
|
|
617
819
|
|
|
618
820
|
## 📞 Support
|
|
619
821
|
|
|
620
822
|
- **Documentation**: [Theme Documentation](https://bamr87.github.io/zer0-mistakes/)
|
|
823
|
+
- **Seed Docs**: [AI Reconstruction Blueprints](.github/seed/README.md)
|
|
824
|
+
- **Product Spec**: [Product Requirements Document](PRD.md)
|
|
621
825
|
- **Issues**: [GitHub Issues](https://github.com/bamr87/zer0-mistakes/issues)
|
|
622
826
|
- **Discussions**: [GitHub Discussions](https://github.com/bamr87/zer0-mistakes/discussions)
|
|
623
827
|
- **Email**: [support@zer0-mistakes.com](mailto:support@zer0-mistakes.com)
|
|
624
828
|
|
|
829
|
+
## 🏆 Project Recognition
|
|
830
|
+
|
|
831
|
+
- ✅ **95% Installation Success Rate** - AI-powered error recovery
|
|
832
|
+
- ✅ **Zero-Configuration Deployment** - Works immediately on GitHub Pages
|
|
833
|
+
- ✅ **Universal Compatibility** - Docker-first for all platforms
|
|
834
|
+
- ✅ **Privacy-First Analytics** - GDPR/CCPA compliant out-of-the-box
|
|
835
|
+
- ✅ **AI-Ready Architecture** - Comprehensive Copilot integration
|
|
836
|
+
- ✅ **Complete Documentation** - 17,500+ lines of reconstruction blueprints
|
|
837
|
+
|
|
625
838
|
---
|
|
626
839
|
|
|
627
|
-
Built with ❤️ for the Jekyll community
|
|
840
|
+
**Built with ❤️ for the Jekyll community** | **Version 0.6.0** | [Changelog](CHANGELOG.md) | [Contributing](CONTRIBUTING.md) | [License](LICENSE)
|