How patons02/hydejack-theme works
Project type and purpose
• This is a Jekyll-based “starter kit” for building a static blog (Hydejack Starter Kit).
• Purpose: provide a folder structure, templates, styles, docs, and example posts to accelerate spinning up a Jekyll site.
File structure
• Top-level directories:
• .bundle, Gemfile → Ruby/Bundler environment
• .github/workflows → CI pipeline (jekyll build/test)
• _config.yml → global Jekyll configuration
• _includes, _sass → partial templates & SASS styles
• _data → site-wide YAML data (authors, social links, strings)
• _featured_categories → content snippets
• assets/img → static images for blog/docs
• docs → detailed user/developer documentation
• example/_posts → sample markdown posts
• index.html, about.md, posts.md → top-level pages
• Patterns:
• Jekyll static-site generator pipeline (Liquid templates + front-matter in markdown)
• SASS build for CSS
• GitHub Actions for CI/deploy
Key README insights
• Build steps: bundle install → bundle exec jekyll serve
• Deployment target: likely GitHub Pages or any static host
• Encourages reading the docs/ folder for advanced configuration
Main components
a. Content & Source layer
• Markdown files (_posts, *.md)
• YAML data files (_data)
• Template partials (_includes)
• SASS files (_sass)
• Config (_config.yml)
b. Build & Tooling layer
• Ruby + Bundler + Gems
• Jekyll engine (Liquid renderer)
• SASS compiler
• GitHub Actions workflow
c. Output & Deployment layer
• Generated static site (_site)
• Hosting (GitHub Pages or static-site host)
d. External services
• Hydejack PRO download site (optional)
• npm/rubygems registry (for dependencies)
Relationships and interactions
• Developer commits source files → Git → GitHub
• On push, GitHub Actions runs bundle install + jekyll build
• YAML + Markdown + Liquid templates + SASS → Jekyll/SASS compilers → _site (HTML/CSS/JS)
• CI job then deploys _site to GitHub Pages (or other host)
• Browser requests files from host → serves static content
Architectural patterns & design principles
• Static-site generator pipeline (no runtime backend)
• Clear separation between content (markdown/YAML), presentation (Liquid + includes), and styling (SASS)
• Convention-over-configuration via _config.yml and directory names
• CI/CD integration for automated build & deploy