Skip to content
Public template

About

The template for web development customers of Chobble.com

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Chobble Client Site Builder

Quick static site generator that combines the Chobble Template with your content.

Quick Start

  1. Add your content - Edit markdown files and images in the relevant folders
  2. Push to GitHub - The site builds automatically via GitHub Actions
  3. Deploy happens automatically - main deploys to Bunny CDN; other branches just build, as a check

What Goes Where

The .pages.yml defines all your content types:

  • pages/ - Static pages with navigation
  • news/ - Blog posts with dates
  • products/ - Shop items with prices and Etsy links
  • categories/ - Product categories
  • team/ - Team member profiles
  • reviews/ - Customer testimonials
  • events/ - Upcoming events
  • menus/, menu-categories/, menu-items/ - Restaurant menu system
  • snippets/ - Reusable content bits
  • images/ - All your images

How It Works

When you push to GitHub:

  1. GitHub Actions merges your content with the template
  2. Builds the static site with Eleventy
  3. Deploys to Bunny CDN, from main only

Configuration

Set these GitHub secrets for your repo:

  • BUNNY_ACCESS_KEY and BUNNY_STORAGE_ZONE_NAME (the Bunny Site to deploy to) - For deployment. Older sites may still name the second BUNNY_PRODUCTION_STORAGE_ZONE_NAME, which works until it is renamed; gh-secrets in the dotfiles does that.
  • FORMSPARK_ID - For contact forms (optional)
  • BOTPOISON_PUBLIC_KEY - For spam protection (optional)
  • INDEXNOW_KEY - For IndexNow search submission (optional)
  • NTFY_TOPIC - For build-failure notifications (optional)

Local Development

This project uses Bun. The Chobble Template is vendored as the chobble-template git submodule, which provides the @chobble/js-toolkit dependency and the Eleventy build.

git submodule update --init   # populate chobble-template (first checkout only)
bun install                   # install dependencies
bun run serve                 # dev server with hot reload
bun run build                 # build the site into _site/
bun run test                  # run the template test suite

Cloning with git clone --recurse-submodules initialises the submodule for you. If bun install fails with ENOENT ... @chobble/js-toolkit, the submodule hasn't been checked out yet - run the git submodule update --init step above.

About

The template for web development customers of Chobble.com

Resources

Stars

0 stars

Watchers

0 watching

Forks

Sponsor this project

Contributors

Languages