Giter VIP home page Giter VIP logo

notionblog's Introduction

A preview of my revamped blogfolio

Nextjs Notion Blog Starter

  • Default demo - Deployed from main branch
  • Blog setup - I wrote an article on how to use this starter to start your blog

✨ Features

  • ✅ Setup takes only a few minutes (single file config) 💪

  • ✅ Newsletter subscription via Convertkit API

  • ✅ Simple analytics with Umami

  • ✅ Automatic OG social images with Tailwind template

  • ✅ Automatic pretty URLs

  • ✅ Excellent page speed

  • ✅ Optimized for Next.js and Vercel

🛠 Build with

📕 Project Overview

  • layouts/* - The different layouts used on each page.
  • components/* - Components used throughout the site.
  • components/notionBlocks/* - Custom blocks made for Notion rendering.
  • utils/* - Short for "utilities", a collection of helpful utilities or code for external services.
  • pages/api/* - API routes powering /og-image dynamic OG image and /subscribe-convertkit newsletter subscription.
  • pages/blog/* - Static pre-rendered blog pages that fetch information from the Notion API.
  • pages/* - All other static pages.
  • public/* - Static assets including images, fonts, and videos.
  • styles/* - global styles and Tailwind.
  • data/* - a simple file containing global data about the site.

🏃‍♂️ Running Locally

git clone https://github.com/tuanphungcz/nextjs-notion-blog-starter
cd nextjs-notion-blog-starter
npm install
npm run dev

Create a .env file similar to .env.example and include the appropriate keys.

🚀 Deploy to vercel

Deploy with Vercel

NOTION_SECRET=
BLOG_DATABASE_ID=

# ConvertKit is optional
NEXT_PUBLIC_CONVERTKIT_FORM_ID=
NEXT_PUBLIC_CONVERTKIT_API_KEY=

# Umami is optional
NEXT_PUBLIC_UMAMI_ID=
NEXT_PUBLIC_UMAMI_URL=

💁‍♀️ How to use

  • Blog setup - I wrote an article on how to use this starter to start your blog

📝 Credit & inspiration

This blog starter was inspired by all of these awesome open-sources

notionblog's People

Contributors

tuanphungcz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.