Awesome Open Source
Awesome Open Source

Nobelium

A static blog build on top of Notion and Nextjs, deployed on Vercel.

Demo: https://nobelium.vercel.app/

Screenshot

Highlights

**  Fast and responsive**

  • Fast page render and responsive design
  • Fast static generation with efficient compiler

**  Deploy instantly**

  • Deploy on Vercel in minutes
  • Incremental regeneration and no need to redeploy after update the content in notion

**  Fully functional**

  • Comments, full width page, quick search and tag filter
  • RSS, analytics, web vital... and much more

**  Easy for customization**

  • Rich config options, support English & Chinese interface
  • Built with Tailwind CSS, easy for customization

**  Pretty URLs and SEO friendly**

Quick Start

  • Star this repo
  • Duplicate this Notion template, and share it to the public
  • Fork this project
  • Customize blog.config.js
  • (Optional) Replace favicon.svg, and favicon.ico in /public folder with your own
  • Deploy on Vercel, set following environment variables
    • NOTION_PAGE_ID (Required): The ID of the Notion page you previously shared to the web, usually has 32 digits after your workspace address
    • NOTION_ACCESS_TOKEN (Optional, not recommended): If you decide not to share your database, you can use token to let Nobelium grab data from Notion database. You can find it in your browser cookies called token_v2
      • Keep in mind Notion token is only valid for 180 days, make sure to update manually in vercel dashboard, we probably switch to Official API to resolve this issue in the future. Also, images in Notion database will not properly rendered
  • That's it! Easy-peasy?
Wait for a sec, what is Page ID

Play With Docker

Unofficial, thanks to @Vaayne's work!

# set env
export NOTION_PAGE_ID=xxx # your NOTION_PAGE_ID
export IMAGE=nobelium:latest

# build with docker
docker build -t ${IMAGE} --build-arg NOTION_PAGE_ID .

# run with docker
docker run -d --name nobelium -p 3000:3000 -e NOTION_PAGE_ID=${NOTION_PAGE_ID} nobelium:latest

Roadmap

Check out our roadmap here

  • [x] Better SEO
  • [x] Dark mode
  • [x] Open Graph support
  • [x] Switch to react-notion-x
  • [x] Sitemap
  • [ ] ...

Technical details

  • Generation: Next.js and Incremental Static Regeneration
  • Page render: react-notion-x
  • Style: Tailwind CSS and @tailwindcss/jit compiler
  • Comments: Gitalk, Cusdis and more

Special Thanks

Notion CN Community
Notion CN Community
yokinist
SilentDepth
Reynard
Lee Robinson
Niin
Spencer Woo

Contributors

Craig Hart
Craig Hart

yokinist
yokinist

Reynard
Reynard

Niin
Niin

Ruter
Ruter

License

The MIT License.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,541,314
Blog (8,719
Vercel (1,210
Notion (287
Related Projects