{"id":25564750,"url":"https://github.com/coditorium/nodejs-favico","last_synced_at":"2025-06-12T21:03:59.720Z","repository":{"id":57233549,"uuid":"87630663","full_name":"coditorium/nodejs-favico","owner":"coditorium","description":null,"archived":false,"fork":false,"pushed_at":"2017-04-14T22:06:10.000Z","size":112,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-16T01:01:41.940Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coditorium.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-08T11:58:59.000Z","updated_at":"2017-07-17T13:02:20.000Z","dependencies_parsed_at":"2022-08-31T14:11:37.671Z","dependency_job_id":null,"html_url":"https://github.com/coditorium/nodejs-favico","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coditorium%2Fnodejs-favico","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coditorium%2Fnodejs-favico/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coditorium%2Fnodejs-favico/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coditorium%2Fnodejs-favico/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coditorium","download_url":"https://codeload.github.com/coditorium/nodejs-favico/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239921842,"owners_count":19718842,"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":"2025-02-20T21:59:34.958Z","updated_at":"2025-02-20T21:59:35.714Z","avatar_url":"https://github.com/coditorium.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# favico - Node.js API\n\n[![Travis Build](https://img.shields.io/travis/coditorium/nodejs-favico.svg?style=flat-square)](https://travis-ci.org/coditorium/nodejs-favico)\n[![Coverage](https://img.shields.io/coveralls/coditorium/nodejs-favico.svg?style=flat-square)](https://coveralls.io/github/coditorium/nodejs-favico)\n[![NPM Version](https://img.shields.io/npm/v/favico.svg?style=flat-square)](http://npm.im/favico)\n[![NPM Downloads](https://img.shields.io/npm/dm/favico.svg?style=flat-square)](http://npm-stat.com/charts.html?package=favico)\n\nSmall favicon generator.\n\n## Features\n\n- Provides Node.js API and CLI for [RealFaviconGenerator](https://realfavicongenerator.net/)\n- Provides caching.\n\n## Examples\n\n**Sample usage via Node.js API**\n\n```js\nconst favico = require(\"favico\");\n\nfavico(config)\n  .then(() =\u003e console.log(\"Favicons are generated\"));\n```\n\n**Sample usage via CLI**\n\n```sh\nfavico -h\nfavico --config ./favicons.json\n```\n\n## Configuration\n\nConfiguration file consists mostly of properties from [RealFaviconGenerator non-interactive api](https://realfavicongenerator.net/api/non_interactive_api).\nFavico use provides some useful [defaults](lib/config.js) and have few additional fields:\n\n- `output` [required, String] - Path to output directory.\n- `reuseOutput` [optional, Boolean] - Do not download favicons if output directory is up to date.\n- `cache` [optional, String] - Path to cache directory. If is not set or set to false cache is disabled. Default value: `false`.\n- `log` [optional, Function/Boolean] - Function to be used for logging. It it is true then `console.log` is used. Default value: `false`.\n\nSample config:\n\n```json\n{\n  \"output\": \"./build/favicons\",\n  \"reuseOutput\": true,\n  \"cache\": \"./.cache/favicons\",\n  \"iconsPath\": \"/favicons\",\n  \"masterPicture\": \"./favicon.png\",\n  \"log\": true,\n  \"design\": {\n    \"ios\": {\n      \"pictureAspect\": \"backgroundAndMargin\",\n      \"backgroundColor\": \"#ffffff\",\n      \"margin\": \"14%\"\n    },\n    \"desktopBrowser\": {},\n    \"windows\": {\n      \"pictureAspect\": \"noChange\",\n      \"backgroundColor\": \"#da532c\",\n      \"onConflict\": \"override\"\n    },\n    \"androidChrome\": {\n      \"pictureAspect\": \"shadow\",\n      \"themeColor\": \"#b5b5b5\",\n      \"manifest\": {\n        \"display\": \"browser\",\n        \"orientation\": \"notSet\",\n        \"onConflict\": \"override\",\n        \"declared\": true\n      }\n    },\n    \"safariPinnedTab\": {\n      \"pictureAspect\": \"silhouette\",\n      \"themeColor\": \"#5bbad5\"\n    }\n  },\n  \"settings\": {\n    \"scalingAlgorithm\": \"Mitchell\",\n    \"errorOnImageTooSmall\": false\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoditorium%2Fnodejs-favico","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoditorium%2Fnodejs-favico","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoditorium%2Fnodejs-favico/lists"}