d0zingcat/nextjs-notion-starter-kit
1
0
Fork 0
mirror of https://github.com/d0zingcat/nextjs-notion-starter-kit.git synced 2026-05-13 15:09:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #594 from onnimonni/document-fix-for-social-media-preview-images

Browse Source
This commit is contained in:
Travis Fischer
2024-11-08 15:18:55 -06:00
committed by GitHub
parent 9ebeda76b4 d476e81f91
commit 54414821d2
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
readme.md
View File

@@ -47,6 +47,7 @@ This project requires a recent version of Node.js (we recommend >= 16).
3. `npm install` 3. `npm install`
4. `npm run dev` to test locally 4. `npm run dev` to test locally
5. `npm run deploy` to deploy to vercel 💪 5. `npm run deploy` to deploy to vercel 💪
6. ❗Disable **Deployment Protection** setting in Vercel Web Dashboard ❗ ([See more below](#vercel-configuration))
I tried to make configuration as easy as possible — All you really need to do to get started is edit `rootNotionPageId`. I tried to make configuration as easy as possible — All you really need to do to get started is edit `rootNotionPageId`.
@@ -58,6 +59,16 @@ In order to find your Notion workspace ID (optional), just load any of your site
I recommend setting up a collection on your home page that contains all of your articles / projects / content. There are no structural constraints on your Notion workspace, however, so feel free to add content as you normally would in Notion. I recommend setting up a collection on your home page that contains all of your articles / projects / content. There are no structural constraints on your Notion workspace, however, so feel free to add content as you normally would in Notion.
### Vercel Configuration
#### Enabling social media preview images
**❗❗❗Social media preview images won't work by default in Vercel❗❗❗**
👉 You need Login to Vercel Dashboard and **disable Vercel Authentication** from `Project -> Settings -> Deployment Protection`.
![How to disable Vercel Deployment Protection setting](https://github.com/user-attachments/assets/a1eb5a1f-da7a-497e-b4f6-f7e851a6cd8a "How to disable Vercel Deployment Protection setting which causes social media preview image endpoint to return 401 Unauthorized")
💡 If you forget to do this your site will return `401 Unauthorized` responses when crawlers are trying to retrieve the images
## URL Paths ## URL Paths
The app defaults to slightly different URL paths in dev vs prod (though pasting any dev pathname into prod will work and vice-versa). The app defaults to slightly different URL paths in dev vs prod (though pasting any dev pathname into prod will work and vice-versa).