From dab6ecd71059421d063fa49b3054a1ac563a88ee Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Wed, 6 Apr 2022 11:07:48 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index f5d9420..718c84c 100644 --- a/readme.md +++ b/readme.md @@ -23,8 +23,8 @@ It uses Notion as a CMS, [react-notion-x](https://github.com/NotionX/react-notio - Next.js / TS / React / Notion - Excellent page speeds - Smooth image previews -- Automatic pretty URLs - Automatic social images +- Automatic pretty URLs - Automatic table of contents - Full support for dark mode - Quick search via CMD+K / CMD+P @@ -48,15 +48,15 @@ This project requires a recent version of Node.js (>= 14.17). 4. `npm run dev` to test locally 5. `npm run deploy` to deploy to vercel 💪 -I tried to make configuration as easy as possible. +I tried to make configuration as easy as possible — All you really need to do to get started is edit `rootNotionPageId`. -All you really need to do to get started is edit `rootNotionPageId`. It defaults to rendering my site's public notion page [78fc5a4b88d74b0e824e29407e9f1ec1](https://notion.so/78fc5a4b88d74b0e824e29407e9f1ec1). +We recommend duplicating the [default page](https://notion.so/7875426197cf461698809def95960ebf) as a starting point, but you can use any public notion page you want. -You'll want to make your root Notion page **public** and then copy the link to your clipboard. Then extract the last part of the URL that looks like `d1b5dcf8b9ff425b8aef5ce6f0730202`, which is your page's Notion iD. +Make sure your root Notion page is **public** and then copy the link to your clipboard. Extract the last part of the URL that looks like `7875426197cf461698809def95960ebf`, which is your page's Notion iD. In order to find your Notion workspace ID (optional), just load any of your site's pages into your browser and open up the developer console. There will be a global variable that you can access called `block` which is the Notion data for the current page. If you enter `block.space_id`, it will print out your page's workspace ID. -I recommend setting up a collection on your home page (optional; I use an inline gallery [here](https://notion.so/78fc5a4b88d74b0e824e29407e9f1ec1)) 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 would normally 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. ## URL Paths @@ -171,7 +171,7 @@ To enable, just add a `NEXT_PUBLIC_POSTHOG_ID` environment variable, which will If you're using Redis, analytics, or any other feature which requires environment variables, then you'll need to [define them in Vercel](https://vercel.com/docs/concepts/projects/environment-variables). -If you want to test your redis builds with GitHub Actions, then you'll need to edit the [default build action](./.github/workflows/build.yml) to add `REDIS_HOST` and `REDIS_PASSWORD`. Here is an [example from my personal branch](<(https://github.com/transitive-bullshit/nextjs-notion-starter-kit/blob/transitive-bullshit/.github/workflows/build.yml#L17-L21)>). You'll also need to add these environment variables to your GitHub repo as [repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets). +If you want to test your redis builds with GitHub Actions, then you'll need to edit the [default build action](./.github/workflows/build.yml) to add `REDIS_HOST` and `REDIS_PASSWORD`. Here is an [example from my personal branch](https://github.com/transitive-bullshit/nextjs-notion-starter-kit/blob/transitive-bullshit/.github/workflows/build.yml#L17-L21). You'll also need to add these environment variables to your GitHub repo as [repository secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets). ## Contributing