Skip to content

Commit a06b534

Browse files
committed
add readme
1 parent 27b4f78 commit a06b534

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
2+
<p align="center">
3+
<a href="https://www.npmjs.com/package/gridsome-plugin-pwa">
4+
<img src="https://gridsome.org/logos/logo-circle-light.svg" alt="gridsome logo" width="100px"/>
5+
</a>
6+
<h1 align="center">gridsome-plugin-hasnode-devblog</h1>
7+
<p align="center">
8+
Gridsome plugin to retrieve blog posts from your <a href = "https://hashnode.com/devblog">devblog</a> on <a href = "https://hashnode.com/">hashnode</a>. </p>
9+
<p align="center"><a href="https://npmjs.com/package/gridsome-source-hashnode-devblog"><img src="https://badge.fury.io/js/gridsome-source-hashnode-devblog.svg" alt="npm version"></a><img alt="npm" src="https://img.shields.io/npm/dt/gridsome-source-hashnode-devblog"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"><img src="https://badgen.net/github/license/nishantwrp/gridsome-source-hashnode-devblog"><img src="https://img.shields.io/david/nishantwrp/gridsome-source-hashnode-devblog"></p>
10+
</p>
11+
12+
## Installation
13+
14+
```
15+
# For npm
16+
$ npm install gridsome-source-hashnode-devblog
17+
# For yarn
18+
$ yarn add gridsome-source-hashnode-devblog
19+
```
20+
21+
## Usage
22+
23+
Add `gridsome-source-hashnode-devblog` to plugin array with following configurable options to `gridsome.config.js`
24+
25+
```js
26+
module.exports = {
27+
plugins: [
28+
{
29+
use: 'gridsome-source-hashnode-devblog',
30+
options: {
31+
username: '', // Your username on hashnode
32+
typeName: 'HashnodeDevblog' // Optional
33+
}
34+
}
35+
]
36+
}
37+
```
38+
39+
## Example Query
40+
```
41+
query {
42+
allHashnodeDevblog {
43+
edges {
44+
node {
45+
title
46+
slug
47+
type
48+
dateAdded
49+
contentMarkdown
50+
content
51+
brief
52+
coverImage
53+
tags {
54+
name
55+
}
56+
dateUpdated
57+
}
58+
}
59+
}
60+
}
61+
```
62+
63+
## License (MIT)
64+
65+
Open [LICENSE](./LICENSE) file for more info

0 commit comments

Comments
 (0)