primer-support
Advanced tools
primer-support - npm Package Compare versions
Comparing version 0.2.0 to 0.3.0
| { | ||
| "name": "primer-support", | ||
| "version": "0.2.0", | ||
| "description": "GitHub Primer - Support", | ||
| "homepage": "https://github.com/styleguide", | ||
| "version": "0.3.0", | ||
| "main": "support.scss", | ||
| "description": "Sass variables, mixins, and functions for use in our components.", | ||
| "author": "GitHub, Inc.", | ||
| "license": "MIT", | ||
| "homepage": "http://primercss.io/", | ||
| "repository": "https://github.com/primer/support.git", | ||
| "main": "support.scss", | ||
| "bugs": { | ||
| "url": "https://github.com/primer/support/issues" | ||
| }, | ||
| "author": "GitHub, Inc.", | ||
| "scripts": { | ||
| "test": "scss-lint *.scss" | ||
| }, | ||
| "keywords": [ | ||
@@ -20,4 +17,11 @@ "primer", | ||
| "github", | ||
| "primercss" | ||
| ] | ||
| "primercss", | ||
| "mixins", | ||
| "functions", | ||
| "variables", | ||
| "scss" | ||
| ], | ||
| "scripts": { | ||
| "test": "scss-lint *.scss" | ||
| } | ||
| } |
@@ -1,27 +0,46 @@ | ||
| ## Primer - Support | ||
| # Primer CSS Support | ||
| [](https://www.npmjs.org/package/primer-support) | ||
| [](https://travis-ci.org/primer/support) | ||
| Support files are Sass variables, mixins, and functions that we import into different bases for use across components, objects, and utilities. Sharing these common properties across GitHub sites helps us to keep our styles more consistent. | ||
| > Support files are Sass variables, mixins, and functions that we import into different bases for use across components, objects, and utilities. Sharing these common properties across GitHub sites helps us to keep our styles more consistent. | ||
| > | ||
| > Most of the time to include these you'll only need to add `@import "support/support";` to the top of your bundle. If you want only a specific partial you can import them separately. | ||
| Most of the time to include these you'll only need to add `@import "support/support";` to the top of your bundle. If you want only a specific partial you can import them separately. | ||
| This repository is a module of the full [primer-css][primer] repository. | ||
| ## Documentation | ||
| You can read more about support in the [docs][docs]. | ||
| ## Install | ||
| Install via `npm install --save primer-support` | ||
| This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-support` with this command. | ||
| ``` | ||
| $ npm install --save primer-support | ||
| ``` | ||
| ## Usage | ||
| Once you have the package installed, you can include in your bundle with something like this | ||
| The source files included are written in [Sass][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this. | ||
| ```scss | ||
| @import "node_modules/primer-support/support"; | ||
| @import "primer-support/index.scss"; | ||
| ``` | ||
| For more info on the available support, visit our [Design systems docs](https://github.com/styleguide/css) | ||
| You can also import specific portions of the module by importing those partials from the `/lib/` folder. _Make sure you import any requirements along with the modules._ | ||
| ## Build | ||
| For a compiled **css** version of this module, a npm script is included that will output a css version to `build/build.css` | ||
| ``` | ||
| $ npm run build | ||
| ``` | ||
| ## Related | ||
| * [GitHub Design Systems](https://github.com/styleguide) | ||
| * [Primer](https://github.com/primer) | ||
| * [Primer Documentation][docs] | ||
| * [primer-css][primer] | ||
@@ -31,1 +50,7 @@ ## License | ||
| MIT © [GitHub](https://github.com/) | ||
| [primer]: https://github.com/primer/primer | ||
| [docs]: http://primercss.io/ | ||
| [npm]: https://www.npmjs.com/ | ||
| [install-npm]: https://docs.npmjs.com/getting-started/installing-node | ||
| [sass]: http://sass-lang.com/ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by80.65%
56
Worsened metrics
- Total package byte prevSize
- decreased by-23.91%
16432
- Number of package files
- decreased by-9.09%
10
- Lines of code
- decreased by-3.09%
188
No dependency changes