> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crunchforms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Jekyll contact form (works on GitHub Pages)

> Add a working contact form to a Jekyll site — including GitHub Pages, where no server code is allowed. Submissions and spam filtering handled by Crunchforms.

GitHub Pages runs Jekyll but forbids server code and plugins that need it — so a contact form has nowhere to send its data. A Crunchforms endpoint fixes that without leaving GitHub Pages.

## Before you start: create your endpoint

Every guide on this page needs a Crunchforms form ID. Getting one takes about two minutes:

1. [Sign up free](https://crunchforms.com/auth/signup) — 1,000 submissions a month included, no credit card required.
2. In your [dashboard](https://crunchforms.com/dashboard), click **New Form**, give it a name, and pick a response type: **Redirect** for classic form posts (the visitor lands on your thank-you page), or **JSON** if you'll submit with JavaScript and handle the response yourself.
3. Your endpoint is `https://crunchforms.com/form/{formID}` — copy it with the **Copy Action URL** button, or use the dashboard's snippet generator.

The [quickstart](/quickstart) covers this in more detail.

## As a Jekyll include

Keep the form ID in `_config.yml` so it's set in one place:

```yaml _config.yml theme={null}
crunchforms_id: "{formID}"
```

```html _includes/contact-form.html theme={null}
<form action="https://crunchforms.com/form/{{ site.crunchforms_id }}" method="post">
  <label for="name">Name</label>
  <input name="name" type="text" id="name" required />

  <label for="email">Email</label>
  <input name="email" type="email" id="email" required />

  <label for="message">Message</label>
  <textarea name="message" id="message" rows="5" required></textarea>

  <button type="submit">Send message</button>
</form>
```

Then anywhere in a page or layout:

```liquid contact.md theme={null}
---
layout: page
title: Contact
---

Have a question? Send us a note.

{% include contact-form.html %}
```

## The thank-you page

Add a `thanks.md` page, set the form's response type to **Redirect**, and enter `https://yourname.github.io/thanks/` (or your custom domain) as the success URL.

## Stop the spam before it starts

Every public form gets found by bots eventually. Crunchforms filters submissions server-side on **every plan, including Free**:

<CardGroup cols={3}>
  <Card title="Honeypot" icon="honey-pot" href="/advanced/honeypot">
    A hidden field humans never see — if it's filled, the submission is rejected. Zero friction for real visitors.
  </Card>

  <Card title="Cloudflare Turnstile" icon="cloudflare" href="/advanced/turnstile">
    Invisible bot detection. Add the widget to your form and Crunchforms validates the token server-side.
  </Card>

  <Card title="reCAPTCHA v3" icon="google" href="/advanced/recaptcha">
    Score-based validation with a threshold you control per form.
  </Card>
</CardGroup>

The honeypot alone stops most drive-by spam and takes one extra line of markup — enable it in your form's settings, then include the hidden field in your form.

## Troubleshooting

<AccordionGroup>
  <Accordion title="The form posts, but nothing shows in my dashboard" icon="magnifying-glass">
    * Check the form is set to **Active** in your dashboard.
    * If you've enabled Turnstile or reCAPTCHA on the form, submissions without a valid token are rejected — including your own tests.
    * Check you haven't exceeded your plan's monthly submission quota.
  </Accordion>

  <Accordion title="The visitor isn't redirected after submitting" icon="arrow-right">
    Set the form's response type to **Redirect** and provide a success URL (and a failure URL) in the form settings. If you're submitting with JavaScript, use the **JSON** response type instead and navigate in your code.
  </Accordion>

  <Accordion title="Submitting with fetch/XHR fails" icon="code">
    The endpoint accepts cross-origin requests, JSON bodies (`Content-Type: application/json`), and classic URL-encoded form bodies. Set the form's response type to **JSON** so your code gets `{ "success": true }` back instead of a redirect.
  </Accordion>

  <Accordion title="I want to test without deploying my site" icon="flask">
    Use the **Send Test Submission** action next to your form in the dashboard — it posts a sample submission to your live endpoint so you can see the pipeline working end to end.
  </Accordion>
</AccordionGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Form configuration" icon="sliders" href="/form-config">
    Response types, notification emails, daily summaries, and more
  </Card>

  <Card title="Free HTML form templates" icon="file-code" href="https://crunchforms.com/templates">
    Contact, feedback, RSVP, job application, and quote-request forms ready to paste
  </Card>
</CardGroup>

## Need help?

<Card title="Get Support" icon="envelope" horizontal href="https://crunchforms.com/support">
  Send us a note — we read everything.
</Card>