How richzendy/jekyll-boilerplate works
Project type and purpose
• This is a Jekyll-based static-site starter theme, with asset pipelines driven by Grunt (Node.js) and styling via Bootstrap SCSS.
• Purpose: give developers a ready-to-go front-end theme + build process that produces optimized HTML/CSS/JS for deployment.
Main components
a. Source Repository (Git)
• Markdown, HTML templates (_layouts, _includes, .html pages)
• Data files (_data/*.yml)
• SCSS source (_scss/*)
• JavaScript source (js/*.js)
• Static assets (images, fonts, SVGs)
• Configuration (_config.yml, Gruntfile.js, package.json)
b. Build Toolchain (Grunt on Node.js)
• SASS compilation → CSS
• Autoprefixer → prefixed CSS
• JS concatenation + Uglify → bundle.js
• SVG minification + sprite generation → svg-sprite
• Watch tasks (re-run on file changes)
c. Static Site Generator (Jekyll on Ruby)
• Reads _config.yml, source templates, content, data
• Renders final HTML pages
• Applies layouts/includes/navigation analytics snippets
• Generates sitemap via plugin
d. Development Server
• grunt watch + jekyll serve → Live-reload at localhost:4000
e. Deployment Target
• GitHub Pages or any static-file host / CDN
Relationships & data flows
• Developer commits code → Git
• Grunt pulls SCSS/JS/SVG source → runs tasks → outputs optimized assets into project’s asset folders (e.g., css/, js/, svg/)
• Jekyll takes templates + data + optimized assets → generates the final / _site directory (static HTML)
• Dev server serves / _site to browser
• CI/CD or manual push → deploy / _site to host/CDN
Architectural patterns & design principles
• Clear separation of concerns:
• Presentation layer (SCSS/components/layouts)
• Build layer (Grunt tasks chaining Node.js tools)
• Content generation layer (Jekyll templates + data)
• Modular SCSS architecture: bootstrap overrides, utility, layout, component folders
• Templating via Jekyll’s include/layout hierarchy
• Data-driven loops via YAML in _data/ for galleries, nav, etc.
Essential details to capture
• SCSS structure: _bootstrap.scss import control, components/, layout/, utils/
• Grunt tasks sequence: sass → autoprefixer → concat → uglify → svgmin/svgstore → watch
• Jekyll’s directory roles: _includes, _layouts, _data, root .html pages
• Live-reload workflow: dual terminals for Grunt watch + Jekyll serve
• Deployment flow: build artifacts (_site) → push to hosting environment