vtex-tachyons
Advanced tools
Comparing version 1.0.1 to 1.0.2
@@ -5,3 +5,3 @@ { | ||
], | ||
"spacing": [0, 0.25, 0.5, 1, 1.5, 2, 4, 8, 16], | ||
"spacing": [0, 0.25, 0.5, 0.75, 1, 1.5, 2, 3, 4, 8, 16], | ||
"customMedia": [ | ||
@@ -8,0 +8,0 @@ { "s": 20 }, |
@@ -12,4 +12,5 @@ const fs = require('fs') | ||
fs.writeFileSync('tachyons.css', out.css) | ||
fs.writeFileSync('tachyons.min.css', out.min) | ||
} | ||
generate() |
{ | ||
"name": "vtex-tachyons", | ||
"version": "1.0.1", | ||
"version": "1.0.2", | ||
"description": "This project is an **extension** of [tachyons](https://github.com/tachyons-css/tachyons). Files in `src/` add or redefine classes in `tachyons`, and the final built files bundle the original `tachyons`.", | ||
"main": "tachyons.css", | ||
"scripts": { | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
"prepublishOnly": "node index.js" | ||
}, | ||
@@ -9,0 +9,0 @@ "repository": { |
# vtex-tachyons | ||
This project is an **extension** of [tachyons](https://github.com/tachyons-css/tachyons). | ||
Files in `src/` add or redefine classes in `tachyons`, and the final built files bundle the original `tachyons`. | ||
## Usage | ||
## How to use | ||
Install | ||
@@ -14,32 +11,6 @@ | ||
You can find the built CSS file in `vtex-tachyons/css/vtex-tachyons.min.css`. | ||
Add to your entry point | ||
Link in your application: | ||
```html | ||
<link rel="stylesheet" href="vtex-tachyons.min.css"> | ||
<link rel="stylesheet" href="theme.min.css"> | ||
``` | ||
or use the CDN | ||
You can always grab the latest version with: | ||
```html | ||
<link rel="stylesheet" href="https://unpkg.com/vtex-tachyons/css/vtex-tachyons.min.css"> | ||
<link rel="stylesheet" href="theme.min.css"> | ||
``` | ||
You can also specify a specific version: | ||
```html | ||
<link rel="stylesheet" href="https://unpkg.com/vtex-tachyons@0.1.5/css/vtex-tachyons.min.css"> | ||
<link rel="stylesheet" href="theme.min.css"> | ||
``` | ||
or | ||
```js | ||
//React Webpack import | ||
import 'vtex-tachyons' | ||
import 'theme' | ||
``` | ||
@@ -51,31 +22,8 @@ | ||
### Local Setup | ||
Change `config.json` and save. | ||
Clone the repo from github and install dependencies through npm. | ||
To generate the new CSS and docs, run: | ||
```js | ||
node index.js | ||
``` | ||
git clone https://github.com/vtex/vtex-tachyons | ||
cd vtex-tachyons | ||
npm install | ||
``` | ||
#### Dev | ||
If you want to just use everything in tachyons/src as a jumping off point and | ||
edit all the code yourself, you can compile all of your wonderful changes by | ||
running | ||
```npm start``` | ||
This will output both minified and unminified versions of the css to the css directory and watch the src directory for changes. | ||
It's aliased to the command: | ||
```npm run build:watch``` | ||
If you'd like to just build the css once without watching the src directory run | ||
```npm run build``` | ||
If you want to check that a class hasn't been redefined or 'mutated' there is a linter to check that all of the classes have only been defined once. This can be useful if you are using another library or have written some of your own css and want to make sure there are no naming collisions. To do this run the command | ||
```npm run mutations``` |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No tests
QualityPackage does not have any tests. This is a strong signal of a poorly maintained or low quality package.
Found 1 instance in 1 package
564812
8
3919
0
28