{"_id":"18f-contrib-web-design-standards","_rev":"4-702588a5a64a1b2ab64a401a8eb89f0a","name":"18f-contrib-web-design-standards","description":"Wrapping the 18F Web Design Standards for use with Node.","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"18f-contrib-web-design-standards","version":"1.0.0","description":"Wrapping the 18F Web Design Standards for use with Node.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["CSS","18F","design","standard","sass"],"author":{"name":"Brian DeRocher","email":"brian@derocher.org"},"license":"ISC","dependencies":{"node-neat":"^1.7.2"},"gitHead":"baf741595766da2de4b760e409279f5cc21103ed","_id":"18f-contrib-web-design-standards@1.0.0","_shasum":"b50d1bc0322be8a888f29339c61fe5a7d196a8a3","_from":".","_npmVersion":"2.14.7","_nodeVersion":"4.2.1","_npmUser":{"name":"openbrian","email":"brian@derocher.org"},"dist":{"shasum":"b50d1bc0322be8a888f29339c61fe5a7d196a8a3","tarball":"https://registry.npmjs.org/18f-contrib-web-design-standards/-/18f-contrib-web-design-standards-1.0.0.tgz","integrity":"sha512-wz6hAlk8WLqPrCPMndWIA/eoX21s6NT6pPdobnXwEkFAohEIqj0kwoVJ6A+MMynNGf0GzaOw/wBCZId+mgq59Q==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBLxqC1TjeeVpvsoMuN497VJLmXTFcI8psYK29R/bKX0AiEAx9PsBSVIayp30QsFjlZP25QiggsNfoQpDPxMpe651J0="}]},"maintainers":[{"name":"openbrian","email":"brian@derocher.org"}]},"1.0.1":{"name":"18f-contrib-web-design-standards","version":"1.0.1","description":"Wrapping the 18F Web Design Standards for use with Node.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/openbrian/18f-contrib-web-design-standards.git"},"keywords":["CSS","18F","design","standard","sass"],"author":{"name":"Brian DeRocher","email":"brian@derocher.org"},"license":"ISC","bugs":{"url":"https://github.com/openbrian/18f-contrib-web-design-standards/issues"},"dependencies":{"node-neat":"^1.7.2"},"gitHead":"19f705ab9b97dd806503b79b3d83b3f84f4b4c07","homepage":"https://github.com/openbrian/18f-contrib-web-design-standards#readme","_id":"18f-contrib-web-design-standards@1.0.1","_shasum":"e49da821e70a8bde772cf696abeb4f4e7a3fc34a","_from":".","_npmVersion":"2.14.7","_nodeVersion":"4.2.1","_npmUser":{"name":"openbrian","email":"brian@derocher.org"},"dist":{"shasum":"e49da821e70a8bde772cf696abeb4f4e7a3fc34a","tarball":"https://registry.npmjs.org/18f-contrib-web-design-standards/-/18f-contrib-web-design-standards-1.0.1.tgz","integrity":"sha512-OjqP2vSI0HKsul8gGMe9/FJLYammwGb7eEKIjuoktXFeJlp0trbLzdRom9SW7cGOB19i/jtYtmpn+jC5AagsJg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCLcNJz/wnkoeBokAjEe54pB6kjeUybCu/WrJwpcCytKQIgf2PKl40wEiv4FxfEwMGyYauYPVq+JwXH0ZF1bo+K/Wk="}]},"maintainers":[{"name":"openbrian","email":"brian@derocher.org"}]}},"readme":"*This is a node-sass based wrapper of the [U.S. Web Design Standards](https://playbook.cio.gov/designstandards/) library.  There are no modifications made to the library.*\n\n# Contents\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Basic Usage](#basic-usage)\n  - [Grunt](#grunt-usage)\n  - [node-sass](#node-sass-usage)\n- [Getting Help](#getting-help)\n- [Testing](#testing)\n- [Credits](#credits)\n- [License](#license)\n\n# Requirements\n- [node](http://nodejs.org)\n- [gulp.js](http://gulpjs.com) -or- [Grunt](http://gruntjs.com) -or- [node-sass](https://github.com/andrew/node-sass)\n\nThis version includes bourbon and neat in it.\n\n# Installation\n\nTo install as a development dependency, run:\n\n```bash\nnpm install --save-dev 18f-contrib-web-desgin-standard\n```\n\nIf you need it in production, replace `--save-dev` with `--save`.\n\n# Usage\n\n## Basic Usage\n\n### Stylesheet usage\n\nAfter setting up Grunt or gulp.js, import the entire U.S. Web Design Standards like this.\n\n```scss\n@import \"all\";\n```\n\n## Grunt Usage\n\n### Using *grunt-sass*\n\nThe [grunt-sass](https://github.com/sindresorhus/grunt-sass) task uses\n[node-sass](https://github.com/andrew/node-sass)\n([LibSass](https://github.com/hcatlin/libsass)) underneath.\n\nExample config:\n\nUsing the compileTasks registered task.  Make sure sass:dev is included in the compileAssets registration if it's not already there.\n\n```javascript\nmodule.exports = function (grunt) {\n  grunt.registerTask('compileAssets', [\n    'clean:dev',\n    'jst:dev',\n    'less:dev',\n    'sass:dev',  // Add this line.\n    'copy:dev',\n    'coffee:dev'\n  ]);\n};\n```\n\nConfiure the sass task like this:\n\n```javascript\nmodule.exports = function(grunt) {\n\n  grunt.config.set('sass', {\n    options: {\n      sourceMap: true,\n      includePaths: require('18f-contrib-web-design-standards').includePaths\n    },\n    dev: {\n      files: {\n        '.tmp/public/styles/main.css': 'assets/styles/main.scss'\n      }\n    }\n  });\n\n  grunt.loadNpmTasks('grunt-sass');\n};\n```\n\n\nExample config wihtout using compileAssets:\n\n```javascript\ngrunt.initConfig({\n  sass: {\n    dist: {\n      options: {\n        includePaths: require('18f-contrib-web-design-standards').includePaths\n      },\n      files: {\n        'path/to/output.css': 'path/to/input.scss'\n      }\n    }\n  }\n});\n```\n\n## node-sass Usage\n\nUsing it directly with [node-sass](https://github.com/andrew/node-sass).\n\n```javascript\nvar sass    = require('node-sass')\nvar neat = require('node-neat');\n\nsass.render({\n  file: './application.scss',\n  success: function(css){\n    console.log(css);\n  },\n  error: function(error) {\n    console.log(error);\n  },\n  // includePaths: neat.with('other/path', 'another/path'),\n  // - or -\n  includePaths: neat.includePaths,\n  outputStyle: 'compressed'\n});\n```\n\n# Getting Help\n\nFeel free to [open a ticket](https://github.com/openbrian/18f-contrib-web-desgin-standard/issues) on GitHub.\n\n# Testing\n\n## How do you know the setup is correct?\n\nYou'll know the pipeline is setup correctly when your path/to/output.css stylesheet is filled with 2,000+ lines of .usa-* class definitions.\n\n## Automated testing\n\nThis is to be fleshed out similar to node-neat.\n\n# Credits\n\nThe U.S. Web Design Standards is made by the fine team at [18F](https://18f.gsa.gov).\n\n# License\n\n18f-contrib-web-design-standards is Copyright © 2015 Brian DeRocher. It is free software, and may be redistributed under the terms specified in the LICENSE file.\n","maintainers":[{"name":"openbrian","email":"brian@derocher.org"}],"time":{"modified":"2022-06-12T14:06:05.752Z","created":"2015-10-19T19:33:08.223Z","1.0.0":"2015-10-19T19:33:08.223Z","1.0.1":"2015-10-25T17:57:34.162Z"},"keywords":["CSS","18F","design","standard","sass"],"author":{"name":"Brian DeRocher","email":"brian@derocher.org"},"license":"ISC","readmeFilename":"README.md","homepage":"https://github.com/openbrian/18f-contrib-web-design-standards#readme","repository":{"type":"git","url":"git+https://github.com/openbrian/18f-contrib-web-design-standards.git"},"bugs":{"url":"https://github.com/openbrian/18f-contrib-web-design-standards/issues"}}