{"id":21767215,"url":"https://github.com/michaelworm/grunt-inky","last_synced_at":"2025-04-13T15:26:36.938Z","repository":{"id":57255220,"uuid":"58064446","full_name":"michaelworm/grunt-inky","owner":"michaelworm","description":"A grunt plugin for ZURB Inky. https://github.com/zurb/inky","archived":false,"fork":false,"pushed_at":"2020-06-24T08:22:51.000Z","size":21,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T06:22:36.078Z","etag":null,"topics":["cheerio","grunt-plugins","inky","zurb"],"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/michaelworm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-04T15:47:39.000Z","updated_at":"2020-06-24T08:22:53.000Z","dependencies_parsed_at":"2022-09-04T14:51:11.425Z","dependency_job_id":null,"html_url":"https://github.com/michaelworm/grunt-inky","commit_stats":null,"previous_names":["miw0/grunt-inky"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelworm%2Fgrunt-inky","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelworm%2Fgrunt-inky/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelworm%2Fgrunt-inky/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelworm%2Fgrunt-inky/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelworm","download_url":"https://codeload.github.com/michaelworm/grunt-inky/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248441616,"owners_count":21104031,"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":["cheerio","grunt-plugins","inky","zurb"],"created_at":"2024-11-26T13:23:05.914Z","updated_at":"2025-04-13T15:26:36.914Z","avatar_url":"https://github.com/michaelworm.png","language":"JavaScript","funding_links":["https://www.paypal.me/Miw0"],"categories":[],"sub_categories":[],"readme":"# grunt-inky\r\n\r\n[![npm](https://img.shields.io/npm/v/grunt-inky.svg?maxAge=86400)](https://www.npmjs.com/package/grunt-inky) \r\n[![npm](https://img.shields.io/npm/dt/grunt-inky.svg?maxAge=86400)](https://www.npmjs.com/package/grunt-inky) \r\n[![Buy me a beer!](https://img.shields.io/badge/Buy%20me%20a%20beer!-%F0%9F%8D%BA-yellow.svg)](https://www.paypal.me/Miw0)\r\n\r\n\u003e A grunt plugin for ZURB Inky. https://github.com/zurb/inky\r\n\r\n```\r\n                      ___\r\n                   .-'   `'.\r\n                  /         \\\r\n                  |         ;\r\n                  |         |           ___.--,\r\n         _.._     |0) ~ (0) |    _.---'`__.-( (_.\r\n  __.--'`_.. '.__.\\    '--. \\_.-' ,.--'`     `\"\"`\r\n ( ,.--'`   ',__ /./;   ;, '.__.'`    __\r\n _`) )  .---.__.' / |   |\\   \\__..--\"\"  \"\"\"--.,_\r\n`---' .'.''-._.-'`_./  /\\ '.  \\ _.-~~~````~~~-._`-.__.'\r\n      | |  .' _.-' |  |  \\  \\  '.               `~---`\r\n       \\ \\/ .'     \\  \\   '. '-._)\r\n        \\/ /        \\  \\    `=.__`~-.\r\n        / /\\         `) )    / / `\"\".`\\\r\n  , _.-'.'\\ \\        / /    ( (     / /\r\n   `--~`   ) )    .-'.'      '.'.  | (\r\n          (/`    ( (`          ) )  '-;\r\n           `      '-;         (-'\r\n```\r\n\r\n## Getting Started\r\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\r\n\r\n```shell\r\nnpm install grunt-inky --save-dev\r\n```\r\n\r\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\r\n\r\n```js\r\ngrunt.loadNpmTasks('grunt-inky');\r\n```\r\n\r\n## The \"inky\" task\r\n\r\n### Overview\r\nIn your project's Gruntfile, add a section named `inky` to the data object passed into `grunt.initConfig()`.\r\n\r\n```js\r\ngrunt.initConfig({\r\n    inky: {\r\n        base: {\r\n            options: {\r\n                // your options for Inky\r\n            },\r\n            files: {\r\n                'dest/index.html': ['src/index.html'],\r\n            }\r\n        }\r\n    }\r\n});\r\n```\r\n\r\nYou can also use this syntax:\r\n\r\n```js\r\ngrunt.initConfig({\r\n    inky: {\r\n        base: {\r\n            options: {\r\n                // your options for Inky\r\n            },\r\n            files: [\r\n                {\r\n                    cwd: 'src/',\r\n                    src: 'index.html',\r\n                    dest: 'dest/',\r\n                    filter: 'isFile',\r\n                    expand: true\r\n                }\r\n            ]\r\n        }\r\n    }\r\n});\r\n```\r\n\r\n### Options\r\n\r\n#### options.cheerio\r\nType: `Object`\u003cbr\u003e\r\nDefault value: \r\n```js\r\n{}\r\n```\r\n\r\nPass options to cheerio. See [cheerio API](https://github.com/cheeriojs/cheerio#api)\r\n\r\n#### options.columnCount\r\nType: `Number`\u003cbr\u003e\r\nDefault value: `12`\r\n\r\nColumn count for the grid. Make sure your Foundation for Emails project has the same column count in the Sass as well.\r\n\r\n#### options.components\r\nType: `Object`\u003cbr\u003e\r\nDefault value: \r\n```js\r\n{\r\n    button: 'button',\r\n    row: 'row',\r\n    columns: 'columns',\r\n    container: 'container',\r\n    inky: 'inky',\r\n    blockGrid: 'block-grid',\r\n    menu: 'menu',\r\n    menuItem: 'item'\r\n}\r\n```\r\n\r\nTag names for custom components. See [Inky Docs for custom elements](https://github.com/zurb/inky#custom-elements)\r\n\r\n## Contributing\r\nIn lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code before submitting a pull request.\r\n\r\n***\r\n\r\n## Thanks\r\n\r\ngrunt-inky was created and is maintained by [Michael Worm](https://github.com/Miw0).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelworm%2Fgrunt-inky","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelworm%2Fgrunt-inky","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelworm%2Fgrunt-inky/lists"}