/nobelium

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

Primary LanguageJavaScriptMIT LicenseMIT

Nobelium

A free and fast blog builder for Notion, and for every creator.

[中文说明 | English]

Showcases

Official demo: https://nobelium.vercel.app/

Screenshot

Amazing points ✨

  • 🚀 Fast and responsive
    • Fast page render and responsive design
    • Static generation and quick building using an efficient compiler
  • 🤖 Serverless and automated
    • Deploy on a free and fast platform, Vercel, in few minutes
    • Incremental rgeneration and the content is always up to date
  • 🚙 Fully functional
    • Comments, quick search and tag filter
    • RSS, about page, analytics, SSL, and more!
  • 🎨 Easy for customization
    • Night mode
    • Nobelium is built using tailwindcss, easy for customization
  • 🕸 Pretty URLs and SEO friendly

Getting started

Step 0: Star this repo

😉

Step 1: Prerequisite

Step 2: Fork this project to customize

  • Fork this project
  • Customize blog.config.js
  • (Optional) Replace avatar.svg, logo.svg, and favicon.ico in /public folder with your own

Step 3: Deploy in few seconds

  • Deploy on Vercel, set following environment variables：
    • NOTION_PAGE_ID: The ID of the Notion page you previously shared to the web, usually has 32 digits after your workspace address
  • That's it! Easy-peasy?

FAQ

Q: Do I need to buy a server?
A: No! You can use Vercel without any cost!

Q: Can I use my own domain?
A: Definitely YES!

Q: What can I customize?
A: Literally everything!

Roadmap

Check out our roadmap here

  • Better SEO
  • Use preact when deploying in production
  • Add more comment system
  • Add more analytics system
  • Dark mode
  • Sitemap
  • Open Graph support
  • Figma design file
  • ...

Technical details

  • Generation: Next.js SSG and Incremental Static Regeneration
  • Page render: React-notion
  • Style: Tailwindcss and @tailwindcss/jit compiler
  • Comments: Gitalk and more incoming
    JavaScript Style Guide

Special Thanks


Notion 中文社区
SilentDepth
Lee Rob
Spencer Woo

Contributors


Craig Hart
🎫 🔧 🎨 🐛
Reynard
🎨 🐛
Niin
🔧 🐛
Ruter
🔧 🐛