{"id":19653015,"url":"https://github.com/csstools/postcss-words","last_synced_at":"2025-04-28T17:31:07.894Z","repository":{"id":57328703,"uuid":"42224380","full_name":"csstools/postcss-words","owner":"csstools","description":"Transform CSS keywords into custom values in CSS","archived":true,"fork":false,"pushed_at":"2016-12-14T18:14:55.000Z","size":7,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-21T21:37:58.806Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/jonathantneal/postcss-words","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csstools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-10T05:36:57.000Z","updated_at":"2024-12-28T18:55:08.000Z","dependencies_parsed_at":"2022-08-31T05:51:29.690Z","dependency_job_id":null,"html_url":"https://github.com/csstools/postcss-words","commit_stats":null,"previous_names":["jonathantneal/postcss-words"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csstools%2Fpostcss-words","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csstools%2Fpostcss-words/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csstools%2Fpostcss-words/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csstools%2Fpostcss-words/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csstools","download_url":"https://codeload.github.com/csstools/postcss-words/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251216342,"owners_count":21553981,"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-11T15:12:55.294Z","updated_at":"2025-04-28T17:31:07.874Z","avatar_url":"https://github.com/csstools.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Words \u003ca href=\"https://github.com/postcss/postcss\"\u003e\u003cimg src=\"https://postcss.github.io/postcss/logo.svg\" alt=\"PostCSS Logo\" width=\"90\" height=\"90\" align=\"right\"\u003e\u003c/a\u003e\n\n[![NPM Version][npm-img]][npm-url]\n[![Build Status][cli-img]][cli-url]\n[![Licensing][lic-image]][lic-url]\n[![Changelog][log-image]][log-url]\n[![Gitter Chat][git-image]][git-url]\n\n[Words] lets you transform CSS words into custom values in CSS.\n\n```json\n{\n    \"midnight-moss\": \"#041004\",\n    \"red\": \"#ce2029\"\n}\n```\n\n```css\n/* before */\n\n.hero {\n    box-shadow: 0 0 0 0 midnight-moss;\n    background-color: red;\n    color: blue;\n}\n\n/* after */\n\n.hero {\n    box-shadow: 0 0 0 0 #041004;\n    background-color: #ce2029;\n    color: blue;\n}\n```\n\n## Options\n\n#### `words`\n\nType: `Object|String`  \nDefault: `.csswords.json`\n\nThe file or object to reference when updating CSS words.\n\n#### `functions`\n\nType: `Array|String`  \nDefault: `[\"url\"]`\n\nA list of functions to avoid parsing within.\n\n## Usage\n\nAdd [Words] to your build tool:\n\n```bash\nnpm install postcss-words --save-dev\n```\n\n#### Node\n\n```js\nrequire('postcss-words').process(YOUR_CSS, { /* options */ });\n```\n\n#### PostCSS\n\nAdd [PostCSS] to your build tool:\n\n```bash\nnpm install postcss --save-dev\n```\n\nLoad [Words] as a PostCSS plugin:\n\n```js\npostcss([\n\trequire('postcss-words')({ /* options */ })\n]).process(YOUR_CSS, /* options */);\n```\n\n#### Gulp\n\nAdd [Gulp PostCSS] to your build tool:\n\n```bash\nnpm install gulp-postcss --save-dev\n```\n\nEnable [Words] within your Gulpfile:\n\n```js\nvar postcss = require('gulp-postcss');\n\ngulp.task('css', function () {\n\treturn gulp.src('./src/*.css').pipe(\n\t\tpostcss([\n\t\t\trequire('postcss-words')({ /* options */ })\n\t\t])\n\t).pipe(\n\t\tgulp.dest('.')\n\t);\n});\n```\n\n#### Grunt\n\nAdd [Grunt PostCSS] to your build tool:\n\n```bash\nnpm install grunt-postcss --save-dev\n```\n\nEnable [Words] within your Gruntfile:\n\n```js\ngrunt.loadNpmTasks('grunt-postcss');\n\ngrunt.initConfig({\n\tpostcss: {\n\t\toptions: {\n\t\t\tuse: [\n\t\t\t\trequire('postcss-words')({ /* options */ })\n\t\t\t]\n\t\t},\n\t\tdist: {\n\t\t\tsrc: '*.css'\n\t\t}\n\t}\n});\n```\n\n[npm-url]: https://www.npmjs.com/package/postcss-words\n[npm-img]: https://img.shields.io/npm/v/postcss-words.svg\n[cli-url]: https://travis-ci.org/jonathantneal/postcss-words\n[cli-img]: https://img.shields.io/travis/jonathantneal/postcss-words.svg\n[lic-url]: LICENSE.md\n[lic-image]: https://img.shields.io/npm/l/postcss-words.svg\n[log-url]: CHANGELOG.md\n[log-image]: https://img.shields.io/badge/changelog-md-blue.svg\n[git-url]: https://gitter.im/postcss/postcss\n[git-image]: https://img.shields.io/badge/chat-gitter-blue.svg\n\n[Words]: https://github.com/jonathantneal/postcss-words\n[PostCSS]: https://github.com/postcss/postcss\n[Gulp PostCSS]: https://github.com/postcss/gulp-postcss\n[Grunt PostCSS]: https://github.com/nDmitry/grunt-postcss\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsstools%2Fpostcss-words","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsstools%2Fpostcss-words","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsstools%2Fpostcss-words/lists"}