gatsby-plugin-ed-comments

gatsby-plugin-ed-comments

RENAMED. Here's the new location, go there: https://www.npmjs.com/package/@debiki/gatsby-plugin-talkyard

The new name is Talkyard (instead of EffectiveDiscussions and ed-comments).

---

Source code: https://github.com/debiki/gatsby-plugin-ed-comments

This adds embedded comments to your website or blog, in an iframe. The commenting system is named Talkyard (previously, it was named EffectiveDiscussions), and it's open source, here: https://github.com/debiki/ed-server

We provide hosting too, see: https://www.talkyard.io/ and look at the Blog Comments price plan.

Example blog post: https://www.kajmagnus.blog/new-embedded-comments
(scroll down to the bottom)

This is Beta software. Maybe you'll need to update your embedding code or config values every now and when, before everything stabilizes.

This plugin will soon be renamed to -talkyard- something.

Installation

NO DON'T INSTALL THIS. The plugin has been RENAMED. Go here instead:

• https://www.npmjs.com/package/@debiki/gatsby-plugin-talkyard

npm install --save gatsby-plugin-ed-comments  # with npm
yarn add gatsby-plugin-ed-comments            # with Yarn

And tell us that you're using this — so we get the chance to notify you about security updates and other stuff. Send us an email: support at ed.community.

How to use

// In your gatsby-config.js
plugins: [
    {
      resolve: `gatsby-plugin-ed-comments`,
      options: {
        commentsServerUrl: 'https://www.example.com'
      }
    },
]

Where https://www.example.com is the address to your Talkyard server, if you have installed it yourself. Or the address to your Talkyard site hosted by us, e.g. https://comments-for-your-blog.talkyard.io.

Then, in your blog post template:

import TalkyardCommentsIframe from 'gatsby-plugin-ed-comments';

// And where the comments shall appear:
<TalkyardCommentsIframe />

Changing the URL of a blog post?

Comments are remembered, per blog post URL. But what if you change the URL? Then all comments will be gone — unless you instead of URLs, use permanent discussion ids that stay the same when you change the URL. For each blog post, add a discussion id: (for all blog posts, otherwise weird bugs)

---
title: Blog post title
author: ...
date: ...
description: ...
discussionId: "2018-01-01-page-slug"   <—— look. You can type whatever, but avoid weird chars
---

Blog post text ...

And also tell React to include the discussion id in the props. At the GraphQL query at the bottom of the blog post template page:

export const pageQuery = graphql`
  query BlogPostBySlug($slug: String!) {
    site {
      siteMetadata {
        title
        author
      }
    }
    markdownRemark(fields: { slug: { eq: $slug } }) {
      id
      html
      frontmatter {
        title
        date ...
        discussionId        <—— look
      }
    }
  }
`;

And also change from: <TalkyardCommentsIframe /> to:

<TalkyardCommentsIframe discussionId={post.frontmatter.discussionId} />

Is this for you?

If you want to quickly test this, to see how it looks & works at your website, without spending time signing up or getting your own server — then, when configuring this plugin, set commentsServerUrl to undefined. Then a temporary test demo site will be used instead — and comments people post might get deleted at any time.

Getting help

Here's our support forum: https://www.talkyard.io/forum/latest/support

Changelog

• v0.4.7 Use CDN CNAME: cdn.talkyard.net, and comments-demo not comments.demo.
• v0.4.6 Use CDN CNAME: cdn.talkyard.io.
• v0.4.5 Rename to Talkyard, should be backwards compatible.
• v0.4.4 Fix compilation error: don't use window.location.
• v0.4.3 Bug fix: Reload comments if navigating to new blog URL.
• v0.4.2 Initial release.

License

Copyright (c) 2017-2018 Kaj Magnus Linberg. The MIT license.