{"id":13566897,"url":"https://github.com/fathyb/html2svg","last_synced_at":"2025-05-16T15:09:29.130Z","repository":{"id":63149265,"uuid":"564694082","full_name":"fathyb/html2svg","owner":"fathyb","description":"Convert HTML and `\u003ccanvas\u003e` to SVG, PDF, or images using Chromium","archived":false,"fork":false,"pushed_at":"2023-11-24T22:14:19.000Z","size":107,"stargazers_count":1231,"open_issues_count":13,"forks_count":31,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-05-13T09:17:38.554Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fathyb.png","metadata":{"files":{"readme":"readme.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-11T09:23:58.000Z","updated_at":"2025-05-08T08:50:34.000Z","dependencies_parsed_at":"2024-08-01T13:39:29.410Z","dependency_job_id":null,"html_url":"https://github.com/fathyb/html2svg","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fathyb%2Fhtml2svg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fathyb%2Fhtml2svg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fathyb%2Fhtml2svg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fathyb%2Fhtml2svg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fathyb","download_url":"https://codeload.github.com/fathyb/html2svg/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254553958,"owners_count":22090417,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:02:19.046Z","updated_at":"2025-05-16T15:09:24.119Z","avatar_url":"https://github.com/fathyb.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# `html2svg`\n\nConvert HTML and `\u003ccanvas\u003e` to vector (SVG, PDF) or bitmap (PNG, JPEG, WebP) images using Chromium. [Read the blog post](https://fathy.fr/html2svg).\n\n## Usage\n\n```shell\n# Export to SVG\n$ docker run fathyb/html2svg https://google.com \u003e google.svg\n$ docker run fathyb/html2svg https://google.com --format svg \u003e google.svg\n# Export to PDF\n$ docker run fathyb/html2svg https://google.com --format pdf \u003e google.pdf\n# Export to PNG\n$ docker run fathyb/html2svg https://google.com --format png \u003e google.png\n# Display help\n$ docker run fathyb/html2svg --help\nUsage: html2svg [options] [command] \u003curl\u003e\n\nArguments:\n  url                    URL to the web page to render\n\nOptions:\n  -f, --full             capture the entire page\n  -W, --wait \u003cseconds\u003e   set the amount of seconds to wait between the page loaded event and taking the screenshot (default: 1)\n  -w, --width \u003cwidth\u003e    set the viewport width in pixels (default: 1920)\n  -h, --height \u003cheight\u003e  set the viewport height in pixels (default: 1080)\n  -f, --format \u003cformat\u003e  set the output format, should one of these values: svg, pdf, png, jpg, webp (default: \"svg\")\n  --help                 display help for command\n\nCommands:\n  serve [options]\n```\n\n### Server\n\nAn HTTP server is also provided, all CLI options are supported:\n\n```shell\n# Start a server on port 8080\n$ docker run -p 8080:8080 fathyb/html2svg serve\n# Export to SVG\n$ curl -d http://google.fr http://localhost:8080 \u003e google.svg\n$ curl -d '{\"url\": \"http://google.fr\", \"format\": \"svg\"}' http://localhost:8080 \u003e google.svg\n# Export to PDF\n$ curl -d '{\"url\": \"http://google.fr\", \"format\": \"pdf\"}' http://localhost:8080 \u003e google.pdf\n# Export to PNG\n$ curl -d '{\"url\": \"http://google.fr\", \"format\": \"png\"}' http://localhost:8080 \u003e google.png\n# Display help\n$ docker run fathyb/html2svg serve --help\nUsage: html2svg serve [options]\n\nOptions:\n  -H, --host \u003chostname\u003e  set the hostname to listen on (default: \"localhost\")\n  -p, --port \u003chostname\u003e  set the port to listen on (default: 8080)\n  -u, --unix \u003cpath\u003e      set the unix socket to listen on\n  -h, --help             display help for command\n```\n\n## Development\n\nBuilding Chromium is only officially supported on AMD64. If you'd like to target ARM64, cross-compile from AMD64 instead.\n\n### Local\n\nYou'll need to install all tools required to build Chromium: https://www.chromium.org/developers/how-tos/get-the-code/\n\nIf you're running Linux, you can use [the Docker build instructions](#docker) to generate binaries.\n\n1. Fetch dependencies:\n    ```shell\n    $ yarn\n    ```\n2. Clone Electron.js and Chromium using `gclient`:\n    ```shell\n    $ yarn gclient\n    ```\n3. Configure the build system using `gn` using one of these commands:\n    ```shell\n    # for local developement\n    $ yarn gn testing\n    # or for releasing\n    $ yarn gn release\n    # add --ide=xcode if you'd like to generate an Xcode project on macOS\n    $ yarn gn release --ide=xcode\n    ```\n4. Build using `ninja` using one of these commands:\n    ```shell\n    # make a testing build\n    $ yarn ninja testing\n    # make a release build\n    $ yarn ninja release\n    ```\n\n### Docker\n\nWe use `docker run` instead of `Dockerfile` for building Chromium to support incremental building.\n\n```shell\n# Create the build environment\n$ docker build . --build-arg \"WORKDIR=$(pwd)\" --target build-env --tag html2svg-build-env\n# Clone the Chromium/Electron code\n$ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/gclient.sh --revision \"src/electron@cb22573c3e76e09df9fbad36dc372080c04d349e\"\n# Apply html2svg patches\n$ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/patch.sh\n# Install build dependencies\n$ docker run -ti -v $(pwd):$(pwd) html2svg-build-env electron/src/build/install-build-deps.sh\n```\n\nNow you'll have to build binaries, steps differs depending on the platform you'd like to target:\n- AMD64:\n  ```shell\n  # Fetch compiler files\n  $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env electron/src/build/linux/sysroot_scripts/install-sysroot.py --arch=amd64\n  # Generate build files\n  $ 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\\\"\"\n  # Build binaries\n  $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/build.sh release-amd64\n  ```\n- ARM64:\n  ```shell\n  # Fetch compiler files\n  $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env electron/src/build/linux/sysroot_scripts/install-sysroot.py --arch=arm64\n  # Generate build files\n  $ 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\\\"\"\n  # Build binaries\n  $ docker run -ti -v $(pwd):$(pwd) html2svg-build-env scripts/build.sh release-arm64 --target-cpu=arm64\n  ```\n\nFinally, build the Docker image:\n```shell\ndocker build .\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffathyb%2Fhtml2svg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffathyb%2Fhtml2svg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffathyb%2Fhtml2svg/lists"}