https://github.com/blankeos/gojo-satori
Statically building satori images with Node (WIP)
https://github.com/blankeos/gojo-satori
Last synced: 9 months ago
JSON representation
Statically building satori images with Node (WIP)
- Host: GitHub
- URL: https://github.com/blankeos/gojo-satori
- Owner: Blankeos
- License: mit
- Created: 2023-10-27T16:04:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T16:41:41.000Z (over 2 years ago)
- Last Synced: 2025-02-13T08:41:46.718Z (over 1 year ago)
- Language: TypeScript
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## gojo-satori
⚠️ This is a very WIP project. I haven't even coded it yet.
Simple script that makes your OG-images at build-time (static). An alternative
to using `@vercel/og` for attaching a dynamic endpoint to a serverless app.
This way you can use any static site host (GitHub Pages, Netlify, Cloudflare Pages)
while always having unique OG Images for each of your static pages.
### Install
```sh
pnpm install -D gojo-satori
```
### Usage (Custom)
### Usage
By default, gojo-satori uses the file system of your content as the unique name.
Just attach it to your build step and it should work out of the box!
#### 1. Set up your folder structure.
```
| your-project/
|--- content/
| |--- og-image.js
| |--- Hello World.md
| |--- Data.md
|
|--- public/
|--- og-image/
| |--- hello-world.png
| |--- data.png
```
#### 2. Add it to your build step
```json
// package.json
"scripts": {
// ... refers to your other scripts in "build".
"build": "... && gojo-satori --template ./content/og-image.js --content ./content/*.md --out ./public/og-image" ,
},
```