Skip to content

Commit

Permalink
Add the uploaded image from Pull Request #594 and fix the README layo…
Browse files Browse the repository at this point in the history
…ut about the Vercel configuration
  • Loading branch information
onnimonni committed Jan 31, 2024
1 parent 890113f commit 52a12a7
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This project requires a recent version of Node.js (we recommend >= 16).
3. `npm install`
4. `npm run dev` to test locally
5. `npm run deploy` to deploy to vercel 💪
6. Disable *Deployment Protection* in Vercel Web Dashboard. ([See more below](#vercel Configuration))
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`.

Expand All @@ -59,12 +59,13 @@ 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.

### [Vercel Configuration]
### Vercel Configuration
#### Enabling social media preview images
**❗❗❗Social media preview images won't work by default in Vercel❗❗❗**
👉 You need Login to Vercel to disable Vercel Authentication from `Project -> Settings -> Deployment Protection`

<img width="600" alt="Vercel Deployment Protection setting which causes social media preview image function endpoint to return 401 Unauthorized" src="https://github.com/transitive-bullshit/nextjs-notion-starter-kit/assets/5691777/9cce3b60-7102-4c34-a422-9f6572155c10">
👉 You need Login to Vercel Dashboard and **disable Vercel Authentication** from `Project -> Settings -> Deployment Protection`.

![Vercel Deployment Protection setting](https://github.com/transitive-bullshit/nextjs-notion-starter-kit/assets/5691777/9cce3b60-7102-4c34-a422-9f6572155c10 "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

Expand Down

0 comments on commit 52a12a7

Please sign in to comment.