-
-
Notifications
You must be signed in to change notification settings - Fork 399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[all] Add build readme script #996
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-cache | ||
|
||
> JSS plugin that caches the rules and delivers insane performance. | ||
|
||
See our website [jss-plugin-cache](https://cssinjs.org/jss-plugin-cache?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-cache | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-cache | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-camel-case | ||
|
||
> JSS plugin that allows to write camel cased rule properties | ||
|
||
See our website [jss-plugin-camel-case](https://cssinjs.org/jss-plugin-camel-case?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-camel-case | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-camel-case | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-compose | ||
|
||
> JSS plugin for classes composition | ||
|
||
See our website [jss-plugin-compose](https://cssinjs.org/jss-plugin-compose?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-compose | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-compose | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-default-unit | ||
|
||
> JSS plugin that adds default custom unit to numeric values where needed | ||
|
||
See our website [jss-plugin-default-unit](https://cssinjs.org/jss-plugin-default-unit?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-default-unit | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-default-unit | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-expand | ||
|
||
> JSS plugin that gives you a better syntax than CSS. | ||
|
||
See our website [jss-plugin-expand](https://cssinjs.org/jss-plugin-expand?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-expand | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-expand | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-extend | ||
|
||
> JSS plugin that enables mixing in styles. | ||
|
||
See our website [jss-plugin-extend](https://cssinjs.org/jss-plugin-extend?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-extend | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-extend | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-global | ||
|
||
> Global styles for JSS | ||
|
||
See our website [jss-plugin-global](https://cssinjs.org/jss-plugin-global?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-global | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-global | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-isolate | ||
|
||
> True rules isolation through automatic properties reset. | ||
|
||
See our website [jss-plugin-isolate](https://cssinjs.org/jss-plugin-isolate?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-isolate | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-isolate | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-nested | ||
|
||
> JSS plugin that enables support for nested selectors | ||
|
||
See our website [jss-plugin-nested](https://cssinjs.org/jss-plugin-nested?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-nested | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-nested | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-props-sort | ||
|
||
> JSS plugin that ensures style properties extend each other instead of override | ||
|
||
See our website [jss-plugin-props-sort](https://cssinjs.org/jss-plugin-props-sort?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-props-sort | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-props-sort | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-rule-value-function | ||
|
||
> JSS plugin for function value and rule syntax | ||
|
||
See our website [jss-plugin-rule-value-function](https://cssinjs.org/jss-plugin-rule-value-function?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-rule-value-function | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-rule-value-function | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-rule-value-observable | ||
|
||
> JSS plugin for TC39 Observables support | ||
|
||
See our website [jss-plugin-rule-value-observable](https://cssinjs.org/jss-plugin-rule-value-observable?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-rule-value-observable | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-rule-value-observable | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-template | ||
|
||
> JSS plugin enables string templates | ||
|
||
See our website [jss-plugin-template](https://cssinjs.org/jss-plugin-template?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-template | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-template | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-plugin-vendor-prefixer | ||
|
||
> JSS plugin that handles vendor prefixes in the browser | ||
|
||
See our website [jss-plugin-vendor-prefixer](https://cssinjs.org/jss-plugin-vendor-prefixer?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-plugin-vendor-prefixer | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-plugin-vendor-prefixer | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# jss-preset-default | ||
|
||
> Default preset for JSS with selected plugins. | ||
|
||
See our website [jss-preset-default](https://cssinjs.org/jss-preset-default?v=v10.0.0-alpha.8) for more information. | ||
|
||
## Install | ||
|
||
Using npm: | ||
|
||
```sh | ||
npm install jss-preset-default | ||
``` | ||
|
||
or using yarn: | ||
|
||
```sh | ||
yarn add jss-preset-default | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,19 @@ | ||
# jss-starter-kit:🚰 the whole kitchen sink | ||
# jss-starter-kit | ||
|
||
[![Gitter](https://badges.gitter.im/JoinChat.svg)](https://gitter.im/cssinjs/lobby) | ||
> A bundle to get you started playing with JSS. Not optimized for production deployment. | ||
|
||
The `jss-starter-kit` combines all of the other [packages](https://github.com/cssinjs/jss/tree/master/packages) into a single bundle, to make it easy to import directly into a playground like Codepen, or a local HTML file. | ||
See our website [jss-starter-kit](https://cssinjs.org/jss-starter-kit?v=v10.0.0-alpha.8) for more information. | ||
|
||
:warning: This bundle includes every JSS package, unminified. It's great for experimenting, but not suitable for production deployment. | ||
## Install | ||
|
||
## Quick start | ||
Using npm: | ||
|
||
There's an instance of JSS already set up with all of the default plugins, exported as `jss`. | ||
|
||
```javascript | ||
import {jss} from 'https://unpkg.com/jss-starter-kit' | ||
|
||
// Notice that you can use camel-cased style keys here, because | ||
// the default preset include jss-plugin-camel-case. If you want to use | ||
// jss in your production application, you'll need to manually install the | ||
// plugins you need. | ||
const {classes} = jss | ||
.createStyleSheet({ | ||
wrapper: { | ||
padding: 40, | ||
background: '#f7df1e', | ||
textAlign: 'center' | ||
}, | ||
title: { | ||
font: { | ||
size: 40, | ||
weight: 900 | ||
}, | ||
color: '#24292e' | ||
}, | ||
link: { | ||
color: '#24292e', | ||
'&:hover': { | ||
opacity: 0.5 | ||
} | ||
} | ||
}) | ||
.attach() | ||
|
||
document.body.innerHTML = ` | ||
<div class="${classes.wrapper}"> | ||
<h1 class="${classes.title}">Hello JSS!</h1> | ||
<a | ||
class=${classes.link} | ||
href="http://cssinjs.org/" | ||
traget="_blank" | ||
> | ||
See docs | ||
</a> | ||
</div> | ||
` | ||
```sh | ||
npm install jss-starter-kit | ||
``` | ||
|
||
## Plugins | ||
|
||
[Every plugin shipped by JSS](https://github.com/cssinjs/jss/tree/master/packages) is included here. See [`index.js`](https://github.com/cssinjs/jss/blob/master/packages/jss-starter-kit/src/index.js) to see the names they are exported as. | ||
or using yarn: | ||
|
||
## Issues | ||
|
||
File a bug against [cssinjs/jss prefixed with \[jss-starter-kit\]](https://github.com/cssinjs/jss/issues/new?title=[jss-starter-kit]%20). | ||
|
||
## License | ||
|
||
MIT | ||
```sh | ||
yarn add jss-starter-kit | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just realized we have no good place where all exports from the starter kit are documented. We should probably create a docs/jss-starter-kit.md and list them all there