Socket
Book a DemoInstallSign in
Socket

gatsby-source-comment-server

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gatsby-source-comment-server

Provides comment source for gatsby blogs

latest
npmnpm
Version
1.0.0-1
Version published
Weekly downloads
3
Maintainers
1
Weekly downloads
 
Created
Source

Gatsby

Gatsby Source Comment Server

A minimal plugin that pulls comments from https://gatsbyjs-comment-server.herokuapp.com/.

The server is a nodeJS server that serves comments and allows posting of new comments from any website.

Demo

A blog has been created to test this plugin.

See it here.

Note: To load new comments, the server has to be restarted (A fix would come for this in the future).

Installation

npm install gatsby-source-comment-server
// or
yarn add gatsby-source-comment-server

Add into your gatsby-config.js:

//...
module.exports{
  plugins: [
    {
      resolve: "gatsby-source-comment-server",
      options: {
        website: "Unique URL of a blog/website"
      }
    }
  ]
}

What it does

It pulls comments from the server using the website as a distinguishing factor. And adds a new field comments to MarkdownRemak type containing comments that is added with the page slug

Posting of new comment

To post a new comment, a POST /comments can be made using a form with the following field in the body of the request.

  • website: String
  • slug: String
  • name: String
  • content: Content

Consuming comments

To consume a comment update any MarkdownRemark query to look like

query {
  markdownRemark {
    comments: {
      _id
      name
      content
      website
      slug
    }
  }
}

And you can use the graphql helper to fetch the comments.

This comments is an array and could be traversed and rendered using React.

<ul>
  {comments &&
    comments.map((comment) => {
      return (
        <li>
          <div>{comment.author}</div>
          <div>{comment.content}</div>
        </li>
      );
    })}
</ul>

Keywords

gatsby

FAQs

Package last updated on 17 May 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts