{"id":21367474,"url":"https://github.com/isleofcode/render-vendor","last_synced_at":"2025-07-13T05:31:37.677Z","repository":{"id":20233294,"uuid":"84769730","full_name":"isleofcode/render-vendor","owner":"isleofcode","description":"the fastest way to render HTML documents to PDFs","archived":false,"fork":false,"pushed_at":"2023-10-25T21:44:43.000Z","size":1522,"stargazers_count":21,"open_issues_count":13,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-04T19:12:07.534Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://render-vendor.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/isleofcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-13T01:04:12.000Z","updated_at":"2020-01-14T14:06:54.000Z","dependencies_parsed_at":"2023-01-13T20:50:55.427Z","dependency_job_id":null,"html_url":"https://github.com/isleofcode/render-vendor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isleofcode%2Frender-vendor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isleofcode%2Frender-vendor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isleofcode%2Frender-vendor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isleofcode%2Frender-vendor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/isleofcode","download_url":"https://codeload.github.com/isleofcode/render-vendor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225856865,"owners_count":17535135,"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-11-22T07:19:21.788Z","updated_at":"2024-11-22T07:19:22.323Z","avatar_url":"https://github.com/isleofcode.png","language":"JavaScript","readme":"# render-vendor\n\n## render-vendor is the fastest way to render HTML documents to PDFs\n_(or PNGs, JPEGs, BMPs...)_\n\nThe [Renderer](http://render-vendor.com/pages/renderer) loads HTML templates into [Pages](http://render-vendor.com/pages/page), which are later rendered into the\ndesired format. With render-vendor, you can:\n\n- Generate PDFs in 10s of milliseconds (10-100x faster than several popular solutions);\n- Handle jobs asynchronously;\n- Swap internal components, e.g. Headless Chrome vs. PhantomJS; and\n- Integrate easily into modern JS build pipelines (e.g. React, Glimmer, Vue). For Ember + Electron projects, consider using [ember-render-vendor](https://github.com/isleofcode/ember-render-vendor)\n\n\n## Quickstart\n### Installation:\n\nInstall via [yarn](https://yarnpkg.com) or [npm](http://npmjs.org/):\n\n```bash\nyarn add render-vendor\nnpm install render-vendor\n```\n\n[**👶 New to Node.js?:** See more](#new-to-node)\n\n### Usage:\n\nOpen the Node.js REPL (i.e. type `node` in your working directory from above),\nthen run the following:\n\n```javascript\nconst { Renderer } = require('render-vendor');\n\nRenderer.load('https://isleofcode.com').then((page) =\u003e {\n  return page.render('./out.pdf');\n}).catch((err) =\u003e {\n  console.error(err);\n}).then(() =\u003e {\n  Renderer.destroy();\n}).then(() =\u003e {\n  process.exit();\n});\n```\n\nThe process should exit automatically, and your directory should have a shiny\nnew `out.pdf`!\n\n**⚠ BE CAREFUL: the default Renderer boots a parallel PhantomJS\nprocess. It is not bound to your REPL / application's lifecycle. Make sure to\n`destroy()` any Renderers you create.**\n\n## ember-render-vendor\n\nAre you building an Ember.js + Electron app? Check out [ember-render-vendor](https://github.com/isleofcode/ember-render-vendor),\na companion lib that: uses the Broccoli build pipeline to:\n\n- Synchronizes data between your main application and rendered Page objects; and\n- Uses the Broccoli build pipeline to make writing parallel renderers as simple as writing components.\n\n## Credits\nrender-vendor is maintained by [Isle of Code](https://isleofcode.com) in Toronto.\nInitial release was sponsored by [Common Sort](https://commonsort.com).\n\nThanks also to @marcbachmann \u0026 contributors to [`node-html-pdf`](https://github.com/marcbachmann/node-html-pdf), from which the\nPhantomRender's internal `render()` implementation was lovingly aped.\n\n\u003ca name='new-to-node'\u003e\n\n### 👶 New to Node.js:\n\nAssuming you've [installed Node.js](https://nodejs.org/en/download/), try the following:\n\n- `cd` into a working directory (or `mkdir` a new one);\n- Run `npm init` and follow the prompts to create your first `package.json`; then\n- Run the `npm install` command above: `npm install render-vendor`.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisleofcode%2Frender-vendor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fisleofcode%2Frender-vendor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisleofcode%2Frender-vendor/lists"}