Saltar al contenido principal

Feedback widget for Jekyll

PushFeedback collects user feedback directly from your website. This guide covers installation in a Jekyll project.

Feedback widget for docs screenshot

Prerequisites​

Before you begin, you need:

  • A PushFeedback account. If you don't have one, sign up for free.
  • A project created in your PushFeedback dashboard. If you haven't created one yet, follow the steps in the Quickstart guide.
  • A Jekyll project.

Installation​

  1. Open the _includes/head.html file (or the equivalent file that contains the <head> section in your Jekyll theme). Append the following code:

    <!-- Initialize the PushFeedback widget -->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/pushfeedback/dist/pushfeedback/pushfeedback.css">
    <script type="module" src="https://cdn.jsdelivr.net/npm/pushfeedback/dist/pushfeedback/pushfeedback.esm.js"></script>

  2. Open _includes/footer.html or the specific file where you'd like the feedback button to appear. Add the following snippet just before its closing tags:

    <feedback-button project="<YOUR_PROJECT_ID>" button-position="bottom-right" modal-position="bottom-right" button-style="dark">Feedback</feedback-button>

    Replace <YOUR_PROJECT_ID> with your project's ID from the PushFeedback dashboard.

  3. After making these changes, navigate back to your Jekyll project root and run:

    jekyll build

    Once it builds successfully, verify that the feedback button appears and functions correctly on your site.

Next steps​

Choose what to do next:

  • Customization — Adjust the widget's layout, styles, and text.
  • Integrations — Forward feedback to Slack, email, Jira, and more.