Docs Site Using Jekyll

About this Site

Welcome to the third project in my Docs‑as‑Code Portfolio Series, where I’m building and publishing documentation sites using four different static site generators: MkDocs, Hugo, Docusaurus, and Jekyll.

This site represents my work with Jekyll and demonstrates how I approach modern documentation workflows—from information architecture and content strategy to build automation and publishing.

🎯 Purpose of This Project

As a Sr. Technical Writer, I use git‑based workflows and developer‑centric tooling.

This portfolio series is my opportunity to:

  • Strengthen and demonstrate my docs‑as‑code skills
  • Explore and compare popular SSGs used in engineering teams
  • Showcase real examples of my technical writing
  • Build documentation sites end‑to‑end using best practices
  • Create a curated, public‑facing writing and tooling portfolio

Tip:
This page serves as the documentation homepage in this Jekyll version of the project.

⚙️ What I Built Using Jekyll

🔧 Workflow & Architecture

  • Information architecture using Jekyll collections + custom sidebar
  • Markdown authoring and Git‑based reviews
  • Accessibility‑minded content (alt text, semantic headings)

🚀 Build & Delivery

  • GitHub Actions pipeline (Ruby 3.1 via ruby/setup-ruby) with lockfile/platform normalization for Linux runners
  • Pages‑safe asset/link handling using Jekyll URL filters to respect the /<repo> base path
  • Local preview with bundle exec jekyll serve and production builds in CI

Build & Hosting Notes

  • This is a GitHub Pages project site, so assets/links are generated with relative_url to work under /<repo>. 1
  • GitHub Actions is the recommended approach for Pages; it avoids local Windows/Jekyll issues and gives full control over Ruby/plugins. 2

📚 Organized Documentation Examples

User Guides

API Guides

How‑To Articles

Technical Reference Guides

🧱 Tech Stack

  • Jekyll for static generation (Markdown + Liquid templating) 2
  • GitHub Actions to build/deploy (recommended path for GitHub Pages) 2
  • GitHub Pages project‑site hosting; URLs generated with relative_url for subpath safety 1

Source & CI:
Repository · Actions