https://github.com/vladkens/ogp
Open Graph Image Generator for Static Sites
https://github.com/vladkens/ogp
generator hacktoberfest og ogp ogp-image opengraphprotocol rust
Last synced: 6 days ago
JSON representation
Open Graph Image Generator for Static Sites
- Host: GitHub
- URL: https://github.com/vladkens/ogp
- Owner: vladkens
- License: mit
- Created: 2024-10-27T14:14:30.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-02-07T10:00:05.000Z (3 months ago)
- Last Synced: 2025-04-03T02:01:47.219Z (28 days ago)
- Topics: generator, hacktoberfest, og, ogp, ogp-image, opengraphprotocol, rust
- Language: Rust
- Homepage: https://ogp.fly.dev
- Size: 38.1 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# OG Image Generator
OG Image Generator is a service designed to create [Open Graph](https://ogp.me/) images for your static pages. This project is inspired by [og-image-generator](https://github.com/sagarhani/og-image-generator). You can read more about the technical details in this [article](https://vnotes.pages.dev/og-image-generator/).
## Usage
To use this service, add the following meta tag to the `` section of your HTML page template and replace the tokens with your desired values:
```html
```
### Example
Here is an example of how to use the service in a Zola-based blog:
- [Link generation](https://github.com/vladkens/blog/blob/ae18520/templates/base.html#L21)
- [Meta tags](https://github.com/vladkens/blog/blob/ae18520/templates/base.html#L44)
## Self-hosted Version
To run a self-hosted version of the OG Image Generator, use the following Docker command:
```sh
docker run -d -p 8080:8080 -e PUBLIC_URL="https://example.com" --name ogp ghcr.io/vladkens/ogp:dev
```
## Contributing
If you need additional templates or have any suggestions, feel free to open an issue or submit a pull request. Contributions are welcome!