Skip to content

gridaco/H2I

Repository files navigation

html2.io github cover graphic

Html to image as a service

Features

  • HTML/CSS to image
  • HTML/CSS to pdf
  • Markdown to image
  • Built-in fonts & emoji support (Apple emoji OK)
  • Template engine
  • Write Template with React
  • CDN Ready
  • View All Features

Usage

Install

yarn add h2i

Simple usage

import * as H2I from "h2i";

const img = H2I.Client({
  apiKey: "<your-api-key>",
});

img.fromFile("test.html").then((image) => {
  image.save("test.png");
});

img.fromUrl("https://google.com").then((image) => {
  image.save("google.png");
});

img.fromHtml("<h1>Hello world</h1>").then((image) => {
  image.save("hello.png");
});

img.fromMd("# Hello world").then((image) => {
  image.save("hello.png");
});

img
  .fromRepo("https://github.com/gridaco/html2.io", {
    branch: "master",
    path: "README.md",
  })
  .then((image) => {
    image.save("readme.png");
  });

Fonts

Google fonts are supported by default. You can also use custom fonts by uploading them to the dashboard.

Aknowledgements

Special thanks to:

Usefull links

License

The source code and artworks are Apache 2.0 licensed, yet it is not allowed to deploy the whole service to make a replica service for monetization without significant modifications.