https://github.com/nerkarso/gnotion
Turn your Notion pages into a website with instant page loads and SEO optimization
https://github.com/nerkarso/gnotion
Last synced: 10 months ago
JSON representation
Turn your Notion pages into a website with instant page loads and SEO optimization
- Host: GitHub
- URL: https://github.com/nerkarso/gnotion
- Owner: nerkarso
- License: mit
- Created: 2022-08-12T03:34:33.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T12:20:10.000Z (over 1 year ago)
- Last Synced: 2024-11-18T13:42:30.485Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://gnotion.vercel.app
- Size: 850 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gnotion
Turn your Notion pages into a website with instant page loads and SEO optimization.
## Usage
Let's assume you have this [Notion page](https://www.notion.so/nerkarso/Example-8a3e3cf883454b9ca073b125e88715b4) and you want to turn it into a website, then follow these steps:
1. Open Notion page.
2. **Share** > toggle **Share to web**.
3. Turn this: `https://www.notion.so/nerkarso/Example-8a3e3cf883454b9ca073b125e88715b4`
4. Into this: `http://localhost:3000/Example-8a3e3cf883454b9ca073b125e88715b4`
## Environment Variables
Create a `.env.local` file and add the following:
```sh
NEXT_PUBLIC_FAVICON="/img/favicon.png"
NEXT_PUBLIC_OG_IMAGE="/img/og-image.png"
NEXT_PUBLIC_PLACEHOLDER_IMAGE="/img/placeholder.png"
NEXT_PUBLIC_REVALIDATE_TOKEN="gnotion"
NEXT_PUBLIC_SITE_TITLE="Docs"
NEXT_PUBLIC_SITE_URL="https://gnotion.vercel.app"
NEXT_PUBLIC_THEME_FONT_FAMILY="Proxima Nova"
NEXT_PUBLIC_THEME_PRIMARY_COLOR="#3399ff"
NEXT_PUBLIC_AUTH_ENABLED=true
NEXT_PUBLIC_AUTH_PASSWORDS=1
```
## Generate Open Graph Image
```sh
http://localhost:3000/api/og-image?subtitle=Docs&title=Web%20Development&image=https://gnotion.vercel.app/img/placeholder.png
```
## Incremental Static Regeneration
Next.js allows you to create or update static pages after you’ve built your site. Starting with v12.2.0, Next.js supports On-Demand Incremental Static Regeneration to manually purge the Next.js cache for a specific page.
```sh
curl http://localhost:3000/api/revalidate?token=xxxxxx&path=/path/to
```
- `token`: replace with your `NEXT_PUBLIC_REVALIDATE_TOKEN`.
- `path`: the exact path that you want revalidated.
## License
[MIT License](LICENSE)