https://github.com/wonism/gatsby-source-notion-contents
Get gatsby sources from notion with `get-notion-contents`
https://github.com/wonism/gatsby-source-notion-contents
gatsby gatsby-notion gatsby-plugin gatsby-plugins gatsby-source gatsby-source-plugin gatsbyjs notion
Last synced: 8 months ago
JSON representation
Get gatsby sources from notion with `get-notion-contents`
- Host: GitHub
- URL: https://github.com/wonism/gatsby-source-notion-contents
- Owner: wonism
- Created: 2019-12-25T14:39:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T02:23:00.000Z (almost 3 years ago)
- Last Synced: 2025-03-23T21:45:52.370Z (9 months ago)
- Topics: gatsby, gatsby-notion, gatsby-plugin, gatsby-plugins, gatsby-source, gatsby-source-plugin, gatsbyjs, notion
- Language: JavaScript
- Homepage:
- Size: 2.08 MB
- Stars: 37
- Watchers: 1
- Forks: 1
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gatsby-source-notion-contents
> Get gatsby sources from notion
[](https://npmjs.org/package/gatsby-source-notion-contents)
## Installation
```sh
$ npm i -S gatsby-source-notion-contents
```
## ⚠️ Prerequisite
You need a token to use this package if you want to get private contents.
You can get it from [Notion.so](https://www.notion.so/) cookie. the key of it is `token_v2`.
## Options
```ts
type Option = {
token?: string; // Optional. need token when you need to get private contents.
ids?: string[]; // Optional. to get contents that are out of scope.
prefix?: string; // Optional. to add prefix into relative links.
removeStyle?: boolean; // Optional. to remove inline styles.
};
```
__ids__
If the URL is `https://www.notion.so/Personal-Home-db45cd2e7c694c3493c97f2376ab184a`,
You need to add `db45cd2e7c694c3493c97f2376ab184a` into `options.ids`.
## How to use
```js
// In your gatsby-config.js
{
// other configs ...
plugins: [
// other plugins ...
{
resolve: `gatsby-source-notion-contents`,
options: {
token: '<>',
ids: ['<>'],
prefix: '/',
removeStyle: false,
},
},
]
}
```
## How to query
- Get all posts
```graphql
query Notions {
allNotionContent {
edges {
node {
id
contentType
internal {
# ... other properties of internal
content
}
}
}
}
}
```
- Get a post
```graphql
query Notion {
notionContent {
id
contentType
internal {
# ... other properties of internal
content
}
}
}
```
- Get a specific post
```graphql
query Notion {
notionContent(id: { eq: "ID_SPECIFIC_POST" }) {
id
contentType
internal {
# ... other properties of internal
content
}
}
}
```
## Example
#### Sample project
- https://github.com/wonism/gatsby-source-notion-contents-sample
#### Example source
```jsx
const Component = {
const data = useStaticQuery(graphql`
query Notion {
notionContent {
internal {
content
}
}
}
`);
return (
);
};
```
---
