Get started

Chirpy comment widget can be integrated into your website easily. You need to create a project first.

Create a project

Click Create project button on the dashboard page:

dashboard

Fill the form

Fill the form with a name and the domain of your site.

dashboard

Follow the integration guide

Click the Integrate button on the project card:

project card

Follow the integration guide on the dialog.

integration guide

⚠️ Note: you can only embed the widget on website pages that you just input, their domain must be exactly the same. For example, you can't embed the widget on a.example.com if you create a project with domain example.com.

Integration guide

Usage on any website

To embed the comment widget on your website, first add the script tag with your project id to the HTML:

<script
  defer
  src="http://chirpy.dev/bootstrap/comment.js"
  data-chirpy-domain="<your-domain>"
></script>

Then, add the data-chirpy-comment attribute to any HTML element that should render the widget:

<div data-chirpy-comment="true"></div>