Skip to content
This repository has been archived by the owner on Mar 12, 2023. It is now read-only.

Latest commit

 

History

History
112 lines (73 loc) · 4.06 KB

README.md

File metadata and controls

112 lines (73 loc) · 4.06 KB
Raw

English | 日本語 | 한국어

easy-notion-blog

GitHub stars GitHub license

easy-notion-blog is a starter-kit for Notion Blog. It helps you to start your Notion Blog easily and rapidly.
  • 🚀 Quite fast page loading
  • 📝 Can write a blog on your Notion
  • 🛠️ Can fully customize the site's appearance
  • ✅ Using official Notion APIs

Please consider astro-notion-blog as it is being developed well.

Screenshots

📸 Blog side

📸 Notion side

Quick Start

Requirements

Steps

  1. Star this repo 😉
    • It makes me motivative!
  2. Duplicate the template into your Notion.
  3. Note the part of URL https://notion.so/your-account/<HERE>?v=xxxx as DATABASE_ID
    • ex) 158bd90116004cd19aca26ad88cb5c07
    • ⚠️ CAUTION: ?v=NOT_THIS_VALUE. Use ahead strings.
  4. Create an integration and note "Internal Integration Token" as NOTION_API_SECRET
  5. Share a database with your integration at the Notion database page
  6. Go to vercel.com and log-in
  7. Create new project by importing this repository otoyo/easy-notion-blog (Skip creating a team)
  8. In "Configure Project", open "Environment Variables" settings and set NOTION_API_SECRET and DATABASE_ID
  9. Your Notion Blog will be published after deploy

Demo

https://easy-notion-blog-otoyo.vercel.app/blog
See also users' sites from wiki.

How to customize

Additional requirements

Steps

  1. Fork this repo from "Fork" button and clone it into your local workspace.
  2. Set the following environment variables with direnv in the project root.
direnv edit .
export NOTION_API_SECRET=<YOUR_NOTION_API_SECRET>
export DATABASE_ID=<YOUR_DATABASE_ID>
  1. Install dependencies and start local server.
yarn install
yarn dev

In the development environment, non-published posts are also displayed to check their appearance.
But posts without valid Slug won't be displayed.

  1. Open http://localhost:3000 in your browser.
  2. Press Ctrl+C in the terminal to stop.

For more information

See wiki.

Bug reports & feature requests

Please create an issue. Both in English and in Japanese are OK. 😉

🐦 Twitter community

You can get latest information about updates, and you can be supported by other members if you want to know how to customize.

Contribution

Pull requests are welcome.

easy-notion-blog is based on ijjk/notion-blog and otoyo/notion-blog