nitzano / gatsby-source-hashnode Goto Github PK

View Code? Open in Web Editor NEW

4.0 1.0 2.0 3.11 MB

Gatsby source plugin for building websites using Hashnode API as data source

License: MIT License

Dockerfile 3.62% JavaScript 96.32% Shell 0.06%

gatsby gatsby-plugin hashnode

gatsby-source-hashnode's Introduction

gatsby-source-hashnode

Build Gatsby websites with Hashnode as a data source

Highlights
Install
How to use
How to query

Highlights

Retrieves user posts
Calculates estimated reading time
Fetches user details
Converts images for gatsby-plugin-image
Supported versions
- Gatsby v4 ( @latest tag)
- Gatsby v3 (@release-2 tag)

Install

npm install gatsby-source-hashnode

How to use

Configure the plugin in gatsby-config.js:

// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: "gatsby-source-hashnode",
      options: {
        username: "<HASHNODE_USERNAME>",
      },
    },
  ],
};

How to query

Get user posts

{
  allHashNodePost {
    edges {
      node {
        brief # "In this article..."
        coverImage {
          # File node (to be used with gatsby-plugin-image)
          childImageSharp {
            gatsbyImageData(layout: FULL_WIDTH, placeholder: BLURRED)
          }
          # OR
          # url // "https://cdn.hashnode.com/...
        }
        slug # "my-great-article"
        title # "My Great Article"
      }
    }
  }
}

Get post's reading time

(With the kind help of reading-time)

{
  allHashNodePost {
    edges {
      node {
        title
        readingTime {
          minutes # 2
          text # "2 min read"
          time # 120000
          words # 100
        }
      }
    }
  }
}

Get user details

{
  allHashNodeUser {
    edges {
      node {
        _id
        blogHandle # "userhandle1"
        coverImage # "https:/...
        dateJoined # "2014-01-01T01:00:00.000Z"
        isDeactivated # false
        isEvangelist # true
        location # "Canada"
        name # "First last"
        numFollowers # 503
        numFollowing # 14
        numPosts # 50
        numReactions # 95
        photo # "https:/...
        publicationDomain # "blog.mydomain.."
        tagline # "I do stuff"
        username # "username1"
      }
    }
  }
}

gatsby-source-hashnode's People

Contributors

Stargazers

Watchers

Forkers

alexhyett talohana

gatsby-source-hashnode's Issues

Add github actions tests

Run the tests in github actions before merging

Add url helper

Add url field to the full post by using publicationUrl + slug

Publish package with np

Publish with np instead of npm publish

Tasks

install np
build docker-compose for production
try preview publish

Support pagination

Support posts pagination to fetch current page some

Fix production docker builder

set git user name and email in build
yarn login automatically with .npmrc / .yarnrc

Add xo

Add xo linter to the project

Upgrade to yarn v2

Add coverImageNode field

Add coverImageNode field by using createRemoteFileNode() to allow downloading new data.
Update documentation to show how to use the new field

Notes

Use:
- https://www.gatsbyjs.com/docs/how-to/images-and-media/preprocessing-external-images/
- https://www.gatsbyjs.com/plugins/gatsby-source-filesystem/#createremotefilenode

Update np

Update np package and make sure yarn release --release-draft-only works

Move to semantic release

coverImage is coming as null

I ran this query on hashnode api playground

query {
  user(username: "inflame") {
    publication {
      posts(page: 0) {
        title
        brief
        slug
        coverImage
      }
    }
  }
}

It gives url for coverImage. But gatsby-source-hashnode gives null.

Add posts tags

Add post tags to node

Add time read to read to posts node

Add the "X min read" to the post data

Add sample site

Add sample gatsby site to the project to test the library inside
Use envrionment variable for the user

Supoprt gatsby v4

Support gatsby v4
Add v3 branch for maintaince

Use reading time field from hashnode api

Currently readingTime field for every post is estimated with an external library. If Hashnode includes support for it in the official API - use it instead.