Convert HTML and <canvas>
to vector (SVG, PDF) or bitmap (PNG, JPEG, WebP) images using Chromium. Read the blog post.
# Export to SVG
$ docker run fathyb/html2svg https://google.com > google.svg
$ docker run fathyb/html2svg https://google.com --format svg > google.svg
# Export to PDF
$ docker run fathyb/html2svg https://google.com --format pdf > google.pdf
# Export to PNG
$ docker run fathyb/html2svg https://google.com --format png > google.png
# Display help
$ docker run fathyb/html2svg --help
Usage: html2svg [options] [command] <url>
Arguments:
url URL to the web page to render
Options:
-f, --full capture the entire page
-W, --wait <seconds> set the amount of seconds to wait between the page loaded event and taking the screenshot (default: 1)
-w, --width <width> set the viewport width in pixels (default: 1920)
-h, --height <height> set the viewport height in pixels (default: 1080)
-f, --format <format> set the output format, should one of these values: svg, pdf, png, jpg, webp (default: "svg")
--help display help for command
Commands:
serve [options]
An HTTP server is also provided, all CLI options are supported:
# Start a server on port 8080
$ docker run -p 8080:8080 fathyb/html2svg serve
# Export to SVG
$ curl -d https://google.fr https://localhost:8080 > google.svg
$ curl -d '{"url": "https://google.fr", "format": "svg"}' https://localhost:8080 > google.svg
# Export to PDF
$ curl -d '{"url": "https://google.fr", "format": "pdf"}' https://localhost:8080 > google.pdf
# Export to PNG
$ curl -d '{"url": "https://google.fr", "format": "png"}' https://localhost:8080 > google.png
# Display help
$ docker run fathyb/html2svg serve --help
Usage: html2svg serve [options]
Options:
-H, --host <hostname> set the hostname to listen on (default: "localhost")
-p, --port <hostname> set the port to listen on (default: 8080)
-u, --unix <path> set the unix socket to listen on
-h, --help display help for command
Building Chromium is only officially supported on AMD64. If you'd like to target ARM64, cross-compile from AMD64 instead.
You'll need to install all tools required to build Chromium: https://www.chromium.org/developers/how-tos/get-the-code/
If you're running Linux, you can use the Docker build instructions to generate binaries.
- Fetch dependencies:
$ yarn
- Clone Electron.js and Chromium using
gclient
:$ yarn gclient
- Configure the build system using
gn
using one of these commands:# for local developement $ yarn gn testing # or for releasing $ yarn gn release # add --ide=xcode if you'd like to generate an Xcode project on macOS $ yarn gn release --ide=xcode
- Build using
ninja
using one of these commands:# make a testing build $ yarn ninja testing # make a release build $ yarn ninja release
We use docker run
instead of Dockerfile
for building Chromium to support incremental building.
# Create the build environment
$ docker build . --build-arg "WORKDIR=$(pwd)" --target build-env --tag html2svg-build-env
# Clone the Chromium/Electron code
$ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/gclient.sh --revision "src/electron@cb22573c3e76e09df9fbad36dc372080c04d349e"
# Apply html2svg patches
$ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/patch.sh
# Install build dependencies
$ docker run -ti -v $(pwd):$(pwd) html2svg-build-env electron/src/build/install-build-deps.sh
Now you'll have to build binaries, steps differs depending on the platform you'd like to target:
- AMD64:
# Fetch compiler files $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env electron/src/build/linux/sysroot_scripts/install-sysroot.py --arch=amd64 # Generate build files $ docker run -ti -v $(pwd):$(pwd) --workdir $(pwd)/electron/src html2svg-build-env gn gen "out/release-amd64" --args="import(\"//electron/build/args/release.gn\") cc_wrapper=\"ccache\"" # Build binaries $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/build.sh release-amd64
- ARM64:
# Fetch compiler files $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env electron/src/build/linux/sysroot_scripts/install-sysroot.py --arch=arm64 # Generate build files $ docker run -ti -v $(pwd):$(pwd) --workdir $(pwd)/electron/src html2svg-build-env gn gen "out/release-arm64" --args="import(\"//electron/build/args/release.gn\") cc_wrapper=\"ccache\" target_cpu=\"arm64\"" # Build binaries $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/build.sh release-arm64 --target-cpu=arm64
Finally, build the Docker image:
docker build .