Skip to the content.
Repository Guidelines
Project Structure & Module Organization
- Root Markdown pages (
index.md, about.md, resources.md, etc.) define top-level site content.
_posts/ contains blog posts; _layouts/ and _includes/ hold templates and shared partials.
assets/ stores images and static files referenced by pages.
_config.yml controls site settings, plugins, and permalink structure.
netlify.toml defines build and publish settings; _source/index.html preserves a legacy single-page version.
Build, Test, and Development Commands
bundle config set --local path "vendor/bundle" stores gems in-repo for reproducible installs.
bundle install installs Ruby/Jekyll dependencies.
bundle exec jekyll serve --livereload runs the site locally at http://localhost:4000 with live reload.
bundle exec jekyll build produces the static site output in _site/ (matches Netlify build).
- Local builds avoid
site.github metadata to prevent GitHub API calls in a GitLab/Netlify workflow.
Coding Style & Naming Conventions
- Use Markdown with YAML front matter for pages and posts.
- Indent YAML with 2 spaces; keep keys sorted when editing
_config.yml or page metadata.
- Blog posts follow
YYYY-MM-DD-title.md in _posts/.
- Use lowercase, hyphenated filenames for assets (e.g.,
assets/hero-image.jpg).
Testing Guidelines
- There is no automated test suite; verify changes by running
bundle exec jekyll build and reviewing locally.
- For content changes, spot-check internal links and image paths during local preview.
Commit & Pull Request Guidelines
- Commit messages in this repo are short, imperative summaries without prefixes (e.g., “Update footer credits and contact link”).
- PRs should include a brief description, link related issues if applicable, and add screenshots for visual changes.
- Confirm Netlify build compatibility by using the local
jekyll build command before requesting review.
Content Checklist
- Add or update YAML front matter (
title, layout, and permalink where needed).
- Validate internal links and anchors after moving or renaming pages.
- Optimize images and reference them from
assets/ with descriptive, hyphenated filenames.
- Preview the page locally and verify key layouts (home, blog, and any edited pages).
Configuration & Deployment Notes
- Site configuration lives in
_config.yml; deployment settings are in netlify.toml.
- Build artifacts such as
_site/, vendor/, and .bundle/ are intentionally ignored.