A comprehensive Jekyll-based training site for GitHub Customer Success Managers and Customer Success Architects.
- Ruby (2.7 or higher)
- Bundler gem (
gem install bundler)
# Install dependencies
bundle install
# Run the development server
bundle exec jekyll serve
# Open in browser
open http://localhost:4000bundle exec jekyll buildThe built site will be in the _site directory.
github-training/
βββ _config.yml # Jekyll configuration
βββ _includes/ # Reusable HTML partials
β βββ head.html
β βββ training-header.html
β βββ training-footer.html
β βββ glightbox.html
βββ _layouts/ # Page layouts
β βββ training.html # Main training page layout
β βββ training-module.html # Individual module layout
βββ _scss/ # SCSS stylesheets
β βββ _config.scss
β βββ _training.scss
β βββ _training-module.scss
βββ public/
β βββ css/
β βββ main.scss # Main stylesheet entry point
βββ beginner/ # Beginner phase modules (1-4)
βββ intermediate/ # Intermediate phase modules (5-8)
βββ advanced/ # Advanced phase modules (9-14)
βββ index.md # Training home page
βββ Gemfile # Ruby dependencies
βββ README.md # This file
Edit _config.yml to customize:
- Site title and tagline
- Author information
- Navigation links
- Base URL (for subdirectory deployments)
The site uses a GitHub-inspired design. Modify the SCSS files in _scss/ to customize:
_config.scss- Color variables and theme settings_training.scss- Main layout and component styles_training-module.scss- Module-specific styles
- Push to a GitHub repository
- Enable GitHub Pages in repository settings
- Set the source to the root or
/docsfolder
- Add a
CNAMEfile with your domain - Configure DNS to point to GitHub Pages
The static site in _site/ can be deployed to:
- Netlify
- Vercel
- AWS S3/CloudFront
- Azure Static Web Apps
- Any web server
Each module follows a consistent structure:
index.md- Module overview and navigationoverview.md- Context and learning objectivesconcepts.md- Core concepts and theorywalkthrough.md- Step-by-step guidelabs.md- Hands-on exercisesquiz.md- Knowledge check questionsscenarios.md- Real-world customer scenariosresources.md- Additional learning resources
Module pages use these front matter variables:
---
layout: training-module
title: "Page Title"
phase: beginner|intermediate|advanced
module_number: 1
section_number: 1
total_sections: 8
estimated_time: "30 min"
toc: true
# Navigation
prev_section:
title: "Previous Page"
url: "/path/to/prev/"
next_section:
title: "Next Page"
url: "/path/to/next/"
sections:
- title: "Section 1"
short_title: "Section 1"
icon: "π"
url: "/path/to/section/"
---- Fork the repository
- Create a feature branch
- Make your changes
- Submit a pull request
See LICENSE file for details.
Built with β€οΈ using Jekyll