Skip to content
A Next.js site using new SSG support with a Notion backed blog
TypeScript JavaScript CSS
Branch: master
Clone or download
1
Latest commit 056f222 Jan 21, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Add caching, rss generation, and update screenshot Jan 7, 2020
public
scripts Add auto creating table when loading posts failed Jan 12, 2020
src Update code component Jan 22, 2020
.gitignore Update gitignore Jan 8, 2020
.prettierrc.json Add prettier Jan 4, 2020
license Add features list, update theme, and add lint-staged Jan 4, 2020
lint-staged.config.js Add features list, update theme, and add lint-staged Jan 4, 2020
next-env.d.ts Add some initial index data and initial lib methods Jan 3, 2020
next.config.js
now.json Update to provide blog index through env also Jan 5, 2020
package.json Handle more invalid values gracefully and add slug generator Jan 10, 2020
readme.md Update experimental note Jan 19, 2020
tsconfig.json Add prettier Jan 4, 2020
yarn.lock Handle more invalid values gracefully and add slug generator Jan 10, 2020

readme.md

Notion Blog

This is an example Next.js project that shows Next.js' upcoming SSG (static-site generation) support using Notion's private API for a backend.

Note: This example uses the experimental SSG hooks only available in the Next.js canary branch! The APIs used within this example will change over time. Since it is using a private API and experimental features, use at your own risk as these things could change at any moment.

Live Example hosted on ZEIT: https://notion-blog.now.sh/

Getting Started

To view the steps to setup Notion to work with this example view the post at https://notion-blog.now.sh/blog/my-first-post or follow the steps below.

Creating Your Pages Table

Note: this is auto run if a table isn't detected the first time visiting /blog

Using the Pre-Configured Script

  1. Create a blank page in Notion
  2. Clone this repo git clone https://github.com/ijjk/notion-blog.git
  3. Install dependencies cd notion-blog && yarn
  4. Run script to create table NOTION_TOKEN='token' BLOG_INDEX_ID='new-page-id' node scripts/create-table.js See here for finding the id for the new page

Manually Creating the Table

  1. Create a blank page in Notion
  2. Create a inline table on that page, don't use a full page table as it requires querying differently
  3. Add the below fields to the table

The table should have the following properties:

  • Page: this the blog post's page
  • Slug: this is the blog post's slug relative to /blog, it should be a text property
  • Published: this filters blog posts in production, it should be a checkbox property
  • Date: this is when the blog post appears as posted, it should be a date property
  • Authors: this is a list of Notion users that wrote the post, it should be a person property

Example Blog Posts Table

Getting Blog Index and Token

To get your blog index value, open Notion and Navigate to the Notion page with the table you created above. While on this page you should be able to get the page id from either:

  • the URL, if the URL of your page is https://www.notion.so/Blog-S5qv1QbUzM1wxm3H3SZRQkupi7XjXTul then your BLOG_INDEX_ID is S5qv1QbU-zM1w-xm3H-3SZR-Qkupi7XjXTul
  • the loadPageChunk request, if you open your developer console and go to the network tab then reload the page you should see a request for loadPageChunk and in the request payload you should see a pageId and that is your BLOG_INDEX_ID

To get your Notion token, open Notion and look for the token_v2 cookie.

Creating Blog Posts

  1. In Notion click new on the table to add a new row
  2. Fill in the Page name, slug, Date, and Authors
  3. At the top of the content area add the content you want to show as a preview (keep this under 2 paragraphs)
  4. Add a divider block under your preview content
  5. Add the rest of your content under the divider block

Deploy Your Own

Deploy your own Notion blog with ZEIT.

Deploy with ZEIT Now

or

  1. Clone this repo git clone https://github.com/ijjk/notion-blog.git
  2. Add your NOTION_TOKEN and BLOG_INDEX_ID as a secret to Now now secrets add notion-token <token> && now secrets add blog-index-id <blog-index>. See here for how to find these values
  3. Deploy with now

Note: if redeploying with now locally and you haven't made any changes to the application's source and only edited in Notion you will need use now -f to bypass build de-duping

Running Locally

To run the project locally you need to follow steps 1 and 2 of deploying and then follow the below steps

  1. Install dependencies yarn
  2. Expose NOTION_TOKEN and BLOG_INDEX_ID in your environment export NOTION_TOKEN='<your-token>'and export BLOG_INDEX_ID='<your-blog-index-id>' or set NOTION_TOKEN="<your-token>" && set BLOG_INDEX_ID="<your-blog-index-id>" for Windows
  3. Run next in development mode yarn dev
  4. Build and run in production mode yarn build && yarn start

Credits

  • Guillermo Rauch @rauchg for the initial idea
  • Shu Ding @shuding_ for the design help
  • Luis Alvarez @luis_fades for design help and bug catching
You can’t perform that action at this time.