{"id":16266463,"url":"https://github.com/thormeier/generate-placeholder-image","last_synced_at":"2025-07-14T06:07:02.812Z","repository":{"id":50217414,"uuid":"329976059","full_name":"thormeier/generate-placeholder-image","owner":"thormeier","description":"This JS library lets you create placeholder images via JavaScript.","archived":false,"fork":false,"pushed_at":"2021-06-01T19:05:17.000Z","size":25,"stargazers_count":4,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T13:17:14.163Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thormeier.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":"2021-01-15T17:16:17.000Z","updated_at":"2024-01-24T06:32:31.000Z","dependencies_parsed_at":"2022-09-26T20:52:40.196Z","dependency_job_id":null,"html_url":"https://github.com/thormeier/generate-placeholder-image","commit_stats":null,"previous_names":["thormeier/generate-placeholder-images"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/thormeier/generate-placeholder-image","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thormeier%2Fgenerate-placeholder-image","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thormeier%2Fgenerate-placeholder-image/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thormeier%2Fgenerate-placeholder-image/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thormeier%2Fgenerate-placeholder-image/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thormeier","download_url":"https://codeload.github.com/thormeier/generate-placeholder-image/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thormeier%2Fgenerate-placeholder-image/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265250560,"owners_count":23734733,"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-10-10T17:41:58.009Z","updated_at":"2025-07-14T06:07:02.768Z","avatar_url":"https://github.com/thormeier.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generate-placeholder-image\n\nThis JS library lets you create placeholder images via JavaScript.\n[Here's a short post on dev.to describing how this thing was built.](https://dev.to/thormeier/how-to-generate-placeholder-images-with-a-simple-node-script-3ocf)\n\n\n## Usage\n\n### Within your application\n\n* Install this library in your project:\n    ```bash\n    npm i generate-placeholder-image\n    ```\n\n* Import the generator function\n    ```javascript\n    const generatePlaceholderImage = require('generate-placeholder-image')\n    ```\n  \n* Start using it:\n    ```javascript\n    generatePlaceholderImage({\n      width: 300,\n      height: 300,\n      r: 255,\n      g: 255,\n      b: 0,\n      text: 'Hello, World!',\n      output: '/some/directory/images/placeholder.png'\n    })\n    ```\n\n* **If canvas is not working correctly/at all, you might need to compile a few things. Please see [the canvas project wiki](https://github.com/Automattic/node-canvas/wiki/_pages) for detailed explanation.**\n\n#### Config reference with default values\n\n```javascript\n{\n    width: 640,\n    height: 480,\n    r: 255,\n    g: 255,\n    b: 255,\n    text: 'Lorem ipsum',\n    font: 'san-serif',\n    output: './image.png'\n}\n```\n\n### As a standalone script\n\n* Installing it globally:\n    ```bash\n    npm i -g generate-placeholder-image\n    ```\n\n* Start using it:\n    ```bash\n    generate-placeholder-image -w 300 -h 300 -r 255 -g 255 -b 0 -t 'Hello, World!' -o '/some/directory/images/placeholder.png'\n    ```\n\n* Or use it via `npx`:\n    ```bash\n    npx generate-placeholder-image -w 300 -h 300 -r 255 -g 255 -b 0 -t 'Hello, World!' -o '/some/directory/images/placeholder.png'\n    ```\n\n#### CLI config reference with default values\n\n```\nPlaceholder image generator\n\n  Create placeholder images with a single line of bash! \n\nArguments\n\n  -w, --width number    Width of the image. Default: 640                                    \n  -h, --height number   Height of the image. Default: 480                                   \n  -r, --red number      Red part, 0-255. Default: 255                                       \n  -g, --green number    Green part, 0-255. Default: 255                                     \n  -b, --blue number     Blue part, 0-255. Default: 255                                      \n  -t, --text string     Text to put on image. Default: \"Lorem ipsum\"                        \n  -f, --font string     Font the text will be rendered in. Default: \"sans-serif\"            \n  -o, --output string   Path of the image. Default: \"./image.png\"                           \n  --help                Prints this help                                                    \n  -v, --version         Prints the version                                                  \n  --open                Opens the image in your default image viewer afterwards (Linux, OSX and Windows)\n\nExample\n\n  ./generate.js -w 100 -h 100 -r 0 -g 0 -b 255 -t \"Hello, World!\" -f Helvetica  \n  -o ./placeholder.png     \n```\n\n## Currently supported file types\n\n* `image/png` (By specifying a JPG as the output file, for example `generate-placeholder-image -o ./examples/image.jpg`)\n* `image/jpeg` (By specifying a PNG as the output file, for example `generate-placeholder-image -o ./examples/image.jpg`)\n* `application/pdf` (By specifying a PDF as the output file, for example `generate-placeholder-image -o ./examples/image.pdf`)\n* `image/svg+xml` (By specifying an SVG as the output file, for example `generate-placeholder-image -o ./examples/image.svg`)\n\n## Examples\n\nExecuting this (all-default parameters, except `--output`/`-o` or equivalent parameters for the generator function):\n\n```bash\ngenerate-placeholder-image -o ./examples/image.png\n```\n\nproduces:\n\n![image.png](https://raw.githubusercontent.com/thormeier/generate-placeholder-image/main/examples/image.png)\n\n---\n\nExecuting this (changed font):\n\n```bash\ngenerate-placeholder-image -f Times -o ./examples/times.png\n```\n\nproduces this:\n\n![times.png](https://raw.githubusercontent.com/thormeier/generate-placeholder-image/main/examples/times.png)\n\n---\n\nExecuting this (or equivalent parameters for the generator function):\n\n```bash\ngenerate-placeholder-image -w 300 -h 150 -r 255 -g 255 -b 0 -t 'Hello, World!' -o ./examples/hello-world.png\n```\n\nproduces this:\n\n![hello-world.png](https://raw.githubusercontent.com/thormeier/generate-placeholder-image/main/examples/hello-world.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthormeier%2Fgenerate-placeholder-image","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthormeier%2Fgenerate-placeholder-image","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthormeier%2Fgenerate-placeholder-image/lists"}