Free Installation and Usage Guide

Click here to access the help documentation: NotionNext Help Manual - (Completely Free)

Rights Statement

This project's tutorial is a free and open resource intended solely for personal learning use. It is strictly prohibited for any individual or organization to use this tutorial for commercial purposes, including but not limited to direct sales, indirect charges, or any other forms of profit. When reproducing, copying, or sharing this tutorial, the author's information must be retained, and the source clearly cited.

This project only offers paid consultation services authorized by the author's team. Please be vigilant against fraud. Any unauthorized paid services may be subject to legal risks.

You can set up your personal website in just a few minutes. Here is the link to my free tutorial:

NotionNext

中文文档 | README in English

A static blog system built with NextJS and Notion API, deployed on Vercel. Designed for Notion and all creators.

Repository hosting: The main repository is maintained by the GitHub organization notionnext-org (canonical: https://github.com/notionnext-org/NotionNext). Contributions are welcome; see the org page for collaboration. If you cloned before the transfer, run git remote set-url origin https://github.com/notionnext-org/NotionNext.git and verify with git remote -v.

Community

3-Minute Quick Start

# 1) Use Node 20 (nvm recommended)
nvm use || nvm install

# 2) Install Yarn if needed
npm i -g yarn

# 3) Install dependencies and start dev server
yarn
yarn dev

Common commands:

• Local development: yarn dev
• Production build: yarn build
• Static export: yarn export

Note: local workflow stays simple (yarn), while lockfile consistency is enforced in CI.

Developer Docs Navigation

To help new contributors get started quickly, the project keeps docs bilingual with clear entry points:

• Docs index (中文)
• Developer docs (English)
• Contribution (中文)
• Contribution Guide (English)

Themes & preview

• Live theme switcher: preview.tangly1024.com
• All 25 themes: THEMES_CATALOG.md
• New theme? See CONTRIBUTING.md and Theme Migration Guide

Acknowledgements

Special thanks to Craig Hart for initiating the Nobelium project.

Craig Hart

Contributors

This project exists thanks to all the people who contribute.

Technologies Used

• Technical Framework: Next.js
• Styles: Tailwind CSS
• Rendering Tool: React-notion-x
• COMMENT: Twikoo, Giscus, Gitalk, Cusdis, Utterances
• ICON: Fontawesome

License

The MIT License.