Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/craigary/nobelium
A static blog build on top of Notion and NextJS, deployed on Vercel.
https://github.com/craigary/nobelium
blog nextjs-blog nobelium notion notion-blog utterances vercel
Last synced: 2 days ago
JSON representation
A static blog build on top of Notion and NextJS, deployed on Vercel.
- Host: GitHub
- URL: https://github.com/craigary/nobelium
- Owner: craigary
- License: mit
- Created: 2021-03-14T06:52:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T10:05:11.000Z (4 months ago)
- Last Synced: 2024-11-26T06:14:53.271Z (16 days ago)
- Topics: blog, nextjs-blog, nobelium, notion, notion-blog, utterances, vercel
- Language: JavaScript
- Homepage: https://nobelium.js.org
- Size: 4.16 MB
- Stars: 2,995
- Watchers: 23
- Forks: 1,965
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - craigary/nobelium - A static blog build on top of Notion and NextJS, deployed on Vercel. (JavaScript)
README
# Nobelium
A static blog build on top of Notion and Nextjs, deployed on [Vercel](https://vercel.com?utm_source=Craigary&utm_campaign=oss).
Demo: [https://nobelium.vercel.app/](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](https://craigary.notion.site/ee99f65a23ab44f8ac80270122ee8138), and share it to the public
- [Fork](https://github.com/craigary/nobelium/fork) this project
- Customize `blog.config.js`
- _(Optional)_ Replace `favicon.svg`, and `favicon.ico` in `/public` folder with your own
- Deploy on [Vercel](https://vercel.com), 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](https://github.com/craigary/nobelium/pull/157)'s work!
### Build Docker image yourself
```
# 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
```
### Use default docker image
```
# pull image
docker pull ghcr.io/craigary/nobelium:main
# run with docker
docker run -d --name nobelium -p 3000:3000 -e NOTION_PAGE_ID=${NOTION_PAGE_ID} ghcr.io/craigary/nobelium:main
```
## Roadmap
Check out our roadmap [here](https://craigary.notion.site/Public-Roadmap-89d184e51653445ab5b347e4efac079e)
- [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](https://github.com/NotionX/react-notion-x)
- **Style**: Tailwind CSS and `@tailwindcss/jit` compiler
- **Comments**: Gitalk, Cusdis and more
## FAQ
How can I change my avatar?
Nobelium fetches avatars from Gravatar. You need to set your avatar there with the same email address that you defined in blog.config.js.
My posts disappear after I set up grouping in Notion database!
Nobelium currently doesn’t support Notion database grouping. If you really want to manage your posts by groups, you can create views with filters instead.
## Special Thanks
Notion CN Community
SilentDepth
Lee Robinson
Spencer Woo
## Contributors
Craig Hart
🎫 🔧 🎨 🐛
yokinist
🔧 🐛
Reynard
🎨 🐛
Niin
🔧 🐛
Ruter
🔧 🐛
## License
The MIT License.