Skip to content

Add Jekyll example with Buttondown newsletter integration #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jmduke
Copy link
Member

@jmduke jmduke commented Jul 22, 2025

Summary

  • Introduces a complete Jekyll static site example integrated with Buttondown newsletter subscription
  • Adds all necessary files including configuration, layout, pages, and a sample blog post
  • Implements client-side JavaScript for handling newsletter form submissions

Changes

Project Structure

  • Added jekyll/ directory with:
    • Gemfile for Ruby dependencies
    • _config.yml with site and Buttondown configuration
    • _layouts/default.html containing the main site layout and embedded newsletter form
    • Markdown content files: index.md, about.md, and a sample blog post in _posts/
    • README.md with detailed setup, usage, and customization instructions

Features

  • Static site generation using Jekyll with the Minima theme
  • Embedded Buttondown newsletter subscription form on every page
  • Responsive and accessible design with custom styling
  • Client-side form submission using JavaScript to interact with Buttondown's API
  • Clear user feedback on subscription success or failure

Test plan

  • Follow README instructions to install dependencies and run the Jekyll server
  • Verify the site renders correctly at http://localhost:4000
  • Test newsletter subscription form with valid and invalid emails
  • Confirm subscription success and error messages display appropriately
  • Check navigation between Home and About pages

This example provides a ready-to-use template for integrating Buttondown newsletters into Jekyll static sites, facilitating easy adoption and customization.

🌿 Generated by Terry


ℹ️ Tag @terragon-labs to ask questions and address PR feedback

📎 Task: https://www.terragonlabs.com/task/4b201d31-f928-4aac-81e7-3de232e01cec

…ration

- Add Gemfile with Jekyll and dependencies
- Add README with setup and usage instructions
- Add _config.yml with site and Buttondown config
- Add default layout with newsletter subscription form and client-side JS
- Add example blog post, about page, and homepage

This initial commit introduces a complete Jekyll example site demonstrating integration with Buttondown newsletter subscriptions, including static site generation, responsive design, and client-side form handling.

Co-authored-by: terragon-labs[bot] <terragon-labs[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant