IsharaBeta
Install guides (31)

Add Ishara to Jekyll

Add the feedback widget to a Jekyll site by pasting one script tag into _includes/footer.html, which your default layout includes.

Where it goes
_includes/footer.html, from _layouts/default.html
Allowed domains
Your own domain (set when you add the site)
Time
About 4 minutes

Steps

  1. In Ishara, open Sites → your site → Install and copy the line under Add the line to your site. Your site’s key is already in it:

    HTML
    <script src="https://useishara.com/w.js" data-site="pk_…" defer></script>
  2. Paste the line at the end of _includes/footer.html (create the file if your site doesn’t have one):

    _includes/footer.html
    <footer><!-- your footer --></footer>
    <script src="https://useishara.com/w.js" data-site="pk_…" defer></script>
  3. Include it from _layouts/default.html, just before </body>:

    _layouts/default.html
    <!doctype html>
    <html lang="en">
      <head><title>{{ page.title }}</title></head>
      <body>
        {{ content }}
        {% include footer.html %}
      </body>
    </html>
  4. Make every page use that layout. Rather than adding layout: default to each file, set it as a default in _config.yml:

    _config.yml
    defaults:
      - scope:
          path: ""
        values:
          layout: "default"
  5. Build and deploy the site.

  6. Open your site. Back on the Install page, Check it’s live turns into The widget is live as soon as the widget loads. Then open the Reviewer link from the same page: only people who open it see Leave a note.

Good to know

  • With a gem-based theme such as minima, don’t edit the installed gem: create the same-named file in your own _includes or _layouts folder, and Jekyll uses yours instead. Start from a copy of the theme’s file to keep what it already had.
  • Liquid outputs HTML you type into a layout or include exactly as written.

Next

Once reviewers leave notes, your coding agent can apply them. The widget’s options (language, position, colour, launcher) are in the docs.