UNPKG

open-props/readme.md

Version:

1.85 kBMarkdownView Raw

1<div align="center">
2  
3![Open Props Logo](https://user-images.githubusercontent.com/1134620/141246730-7df4cf2a-6249-42ca-a01b-494c3ccddabe.png)
4
5## Open Source CSS Variables
6  
7`colors` `gradients` `shadows` `aspect ratios` `typography`  
8`easings` `animations` `sizes` `borders` `z-indexes` `media-queries`  
9
10[![Tests](https://github.com/argyleink/open-props/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/argyleink/open-props/actions/workflows/tests.yml)
11[![npm version](http://img.shields.io/npm/v/open-props.svg)](https://npmjs.org/package/open-props)
12![Discord](https://badgen.net/discord/members/AqA4fU886r)
13  
14<br>
15
16### Need help? &nbsp; 👉 &nbsp; [Discord](https://discord.gg/AqA4fU886r) 
17  
18</div>
19
20<br>
21
22#### CDN ([browse](https://unpkg.com/browse/open-props@latest/))
23- [https://unpkg.com/open-props](https://unpkg.com/open-props)
24- [https://unpkg.com/open-props/normalize.min.css](https://unpkg.com/open-props/normalize.min.css) - Normalize (light + dark) [demo](https://codepen.io/argyleink/pen/KKvRORE)
25- [https://unpkg.com/open-props/open-props.tokens.json](https://unpkg.com/open-props/open-props.tokens.json) - Design Tokens
26- [https://unpkg.com/open-props/open-props.figma-tokens.sync.json](https://unpkg.com/open-props/open-props.figma-tokens.sync.json) - Figma Design Tokens
27
28#### CLI
29- `npm run gen:op` - runs through `src/` js files and creates the PostCSS files in `src/`
30- `npm run gen:nowhere`  - creates a version of Open Props without the use of `:where()`
31- `npm run gen:shadowdom` - creates a version of Open Props with `:host` as the selector scope
32- `npm run gen:prefixed` - creates a version of Open Props with each prop prefixed with `op`, like `--op-font-size-1`
33- `npm run bundle` - creates all the various minified bundles of props
34- `npm run lib:js` - builds the JS modules for NPM

1	`<div align="center">`
2
3	`![Open Props Logo](https://user-images.githubusercontent.com/1134620/141246730-7df4cf2a-6249-42ca-a01b-494c3ccddabe.png)`
4
5	`## Open Source CSS Variables`
6
7	`colors` `gradients` `shadows` `aspect ratios` `typography`
8	`easings` `animations` `sizes` `borders` `z-indexes` `media-queries`
9
10	`[![Tests](https://github.com/argyleink/open-props/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/argyleink/open-props/actions/workflows/tests.yml)`
11	`[![npm version](http://img.shields.io/npm/v/open-props.svg)](https://npmjs.org/package/open-props)`
12	`![Discord](https://badgen.net/discord/members/AqA4fU886r)`
13
14	`<br>`
15
16	`### Need help?   👉   [Discord](https://discord.gg/AqA4fU886r)`
17
18	`</div>`
19
20	`<br>`
21
22	`#### CDN ([browse](https://unpkg.com/browse/open-props@latest/))`
23	`- [https://unpkg.com/open-props](https://unpkg.com/open-props)`
24	`- [https://unpkg.com/open-props/normalize.min.css](https://unpkg.com/open-props/normalize.min.css) - Normalize (light + dark) [demo](https://codepen.io/argyleink/pen/KKvRORE)`
25	`- [https://unpkg.com/open-props/open-props.tokens.json](https://unpkg.com/open-props/open-props.tokens.json) - Design Tokens`
26	`- [https://unpkg.com/open-props/open-props.figma-tokens.sync.json](https://unpkg.com/open-props/open-props.figma-tokens.sync.json) - Figma Design Tokens`
27
28	`#### CLI`
29	- `npm run gen:op` - runs through `src/` js files and creates the PostCSS files in `src/`
30	- `npm run gen:nowhere` - creates a version of Open Props without the use of `:where()`
31	- `npm run gen:shadowdom` - creates a version of Open Props with `:host` as the selector scope
32	- `npm run gen:prefixed` - creates a version of Open Props with each prop prefixed with `op`, like `--op-font-size-1`
33	- `npm run bundle` - creates all the various minified bundles of props
34	- `npm run lib:js` - builds the JS modules for NPM