https://github.com/daliborgogic/ogimage

Open Graph Image as a Service
https://github.com/daliborgogic/ogimage

image open-graph

Last synced: about 1 month ago
JSON representation

Open Graph Image as a Service

• Host: GitHub
• URL: https://github.com/daliborgogic/ogimage
• Owner: daliborgogic
• License: mit
• Created: 2019-08-25T16:06:00.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T03:14:12.000Z (about 2 years ago)
• Last Synced: 2024-10-27T23:51:16.763Z (3 months ago)
• Topics: image, open-graph
• Language: JavaScript
• Homepage: https://api.daliborgogic.com/ogimage/**Open%20Graph**%20Image%20as%20Service.png?theme=dark&md=1&fontSize=100px&slice=9
• Size: 286 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ogimage

> Open Graph Image as a Service. A service that generates dynamic [Open Graph](https://ogp.me/) images that you can embed in your `` tags. For each keystroke, headless chromium is used to render an HTML page and take a screenshot of the result which gets cached.



```html

  Hello World

  

```

| Query     | Description                                                           |

|:----------|:----------------------------------------------------------------------|

|`md`       | `integer` Use Markdown. Value: `O` or `1`. Deafult is `1`.            |

|`theme`    | `string` Switch Theme. Value: `light` or `dark`. Default is `light`.  |

|`fontSize` | `string` Text font size. Default `96px`.                              |

|`images`   | `string` Add image.                                                   |

|`width`    | `integer` Image width.                                                |

|`height`   | `integer` Image height.                                               |

|`slice`    | `integer` If api is in subfolder. (count string length).              |

### Usage

```bash

# Pull image

$ docker pull docker.pkg.github.com/daliborgogic/ogimage/ogimage:{TAG}

#  Run container

$ docker run -d --restart=always -p 3000:3000 docker.pkg.github.com/daliborgogic/ogimage/ogimage:{TAG}

```