Skip to content

swampholyten/notion-style-blog

Repository files navigation

Next.js Notion Cloudflare Kit

An enhanced starter kit for building websites with Next.js and Notion, now optimized for Cloudflare Pages and additional features.

Intro

This repo is a customized version of the Next.js Notion Starter Kit by Travis Fischer. It has been adapted to work seamlessly with Cloudflare Pages and includes additional features, such as:

  • Utterances Integration for blog comments
  • Extended configuration options
  • Enhanced deployment compatibility

It still uses Notion as a CMS via react-notion-x, along with Next.js. For deployments, this version is now optimized for Cloudflare Pages but remains compatible with Vercel.

Features

  • Quick setup with a single configuration file (site.config.ts)
  • Full support for Notion content via react-notion-x
  • Built with Next.js, TypeScript, and React
  • Optimized for Cloudflare Pages and Vercel
  • Excellent performance and page speeds
  • Automatic pretty URLs
  • Smooth image previews
  • Automatic social images
  • Table of contents for long articles
  • Dark mode support
  • Comment support with Utterances
  • Responsive design for different devices

Demos

  • Default Demo - Deployed from the customized version of the starter kit

Setup

All configurations are defined in site.config.ts.

This project requires a recent version of Node.js (recommended >= 16).

  1. Clone this repository.

  2. Customize site.config.ts with your own settings.

  3. Install dependencies:

    npm install
  4. Run locally:

    npm run dev
  5. Deploy to Cloudflare Pages:

  6. Enjoy your new site!

Vercel Support

If you'd like to deploy to Vercel instead, follow the original guide. This version remains fully compatible with Vercel.

Additional Features

Utterances Integration

This version includes Utterances for adding GitHub-powered comments to your blog posts. To enable comments, make sure to configure your Utterances repository in Utterances.tsx.

Contributing

Feel free to fork this repo and submit pull requests for any improvements or features you'd like to add! Contributions are always welcome.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Enjoy building your Next.js and Notion-powered site! 🚀

About

A static notion-styled blog.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published