Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akhilgkrishnan/graphigen
Open graph image generator for the website
https://github.com/akhilgkrishnan/graphigen
image image-generator link-preview metadata og og-image-generator open-graph open-graph-generator open-graph-image open-source seo
Last synced: 18 days ago
JSON representation
Open graph image generator for the website
- Host: GitHub
- URL: https://github.com/akhilgkrishnan/graphigen
- Owner: akhilgkrishnan
- License: mit
- Created: 2023-08-14T13:36:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-23T11:08:14.000Z (9 months ago)
- Last Synced: 2024-12-05T13:13:25.183Z (about 1 month ago)
- Topics: image, image-generator, link-preview, metadata, og, og-image-generator, open-graph, open-graph-generator, open-graph-image, open-source, seo
- Language: TypeScript
- Homepage: https://graphigen.vercel.app
- Size: 227 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GraphiGen - Open Graph Image Generator
GraphiGen is a powerful and user-friendly Open Graph image generator that helps you create stunning preview images for
your website links when shared on social media platforms. With GraphiGen, you can customize and design captivating
visual representations of your web pages, making your content more engaging and shareable.
## Generate Open Graph Images with GraphiGen API
GraphiGen provides an API endpoint that allows you to dynamically generate Open Graph images for your blog posts.
These images can enhance the visual appeal of your shared links on social media platforms. The API supports
customization of author name, title, description, image, date, and content type.
To generate an Open Graph image using the GraphiGen API, make a GET request to the following endpoint:
```
https://graphigen.vercel.app/api/og
```
You can customize the parameters as follows:
- `author`: The author's name.
- `title`: The title of the blog post.
- `category`: The title of the blog post category *(optional)*.
- `description`: A brief description of the blog post.
- `image`: URL of the image to be displayed on the Open Graph image.
- `date`: Date of the blog post.
- `locale`: Locale of the date *(optional, `en-US` by default)*.
- `max`: Max symbols in the brief *(optional)*.
- `type`: Content type (e.g., "blog").
Here's an example URL with parameters:
```
https://graphigen.vercel.app/api/og?author=Akhil%20G%20Krishnan&title=Creating%20Engaging%20Open%20Graph%20Images&description=Learn%20how%20to%20create%20eye-catching%20Open%20Graph%20images%20for%20your%20blog%20posts.&image=https://blog.saeloun.com/images/og_logo.png&date=2023-08-14&type=blog
```
This URL would generate an Open Graph image with the specified details.
Please note that this is a simplified example, and you might need to encode URL parameters if they contain special characters.
You can use this API endpoint to dynamically generate Open Graph images for your blog posts and integrate them into your website or application to enhance the sharing experience on social media platforms.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.