Skip to content

Commit e2458ff

Browse files
author
Henri
authored
[all] Add build readme script (#996)
* Add readme script * Move creating the readmes to rollup * Update readmes * Fix readme content * Move creating readme into own script * Update readme content
1 parent a8b5b0c commit e2458ff

File tree

21 files changed

+381
-60
lines changed

21 files changed

+381
-60
lines changed

packages/jss-plugin-cache/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-cache
2+
3+
> JSS plugin that caches the rules and delivers insane performance.
4+
5+
See our website [jss-plugin-cache](https://cssinjs.org/jss-plugin-cache?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-cache
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-cache
19+
```
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-camel-case
2+
3+
> JSS plugin that allows to write camel cased rule properties
4+
5+
See our website [jss-plugin-camel-case](https://cssinjs.org/jss-plugin-camel-case?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-camel-case
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-camel-case
19+
```

packages/jss-plugin-compose/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-compose
2+
3+
> JSS plugin for classes composition
4+
5+
See our website [jss-plugin-compose](https://cssinjs.org/jss-plugin-compose?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-compose
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-compose
19+
```
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-default-unit
2+
3+
> JSS plugin that adds default custom unit to numeric values where needed
4+
5+
See our website [jss-plugin-default-unit](https://cssinjs.org/jss-plugin-default-unit?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-default-unit
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-default-unit
19+
```

packages/jss-plugin-expand/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-expand
2+
3+
> JSS plugin that gives you a better syntax than CSS.
4+
5+
See our website [jss-plugin-expand](https://cssinjs.org/jss-plugin-expand?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-expand
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-expand
19+
```

packages/jss-plugin-extend/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-extend
2+
3+
> JSS plugin that enables mixing in styles.
4+
5+
See our website [jss-plugin-extend](https://cssinjs.org/jss-plugin-extend?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-extend
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-extend
19+
```

packages/jss-plugin-global/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-global
2+
3+
> Global styles for JSS
4+
5+
See our website [jss-plugin-global](https://cssinjs.org/jss-plugin-global?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-global
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-global
19+
```

packages/jss-plugin-isolate/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-isolate
2+
3+
> True rules isolation through automatic properties reset.
4+
5+
See our website [jss-plugin-isolate](https://cssinjs.org/jss-plugin-isolate?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-isolate
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-isolate
19+
```

packages/jss-plugin-nested/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-nested
2+
3+
> JSS plugin that enables support for nested selectors
4+
5+
See our website [jss-plugin-nested](https://cssinjs.org/jss-plugin-nested?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-nested
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-nested
19+
```
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-props-sort
2+
3+
> JSS plugin that ensures style properties extend each other instead of override
4+
5+
See our website [jss-plugin-props-sort](https://cssinjs.org/jss-plugin-props-sort?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-props-sort
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-props-sort
19+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-rule-value-function
2+
3+
> JSS plugin for function value and rule syntax
4+
5+
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.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-rule-value-function
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-rule-value-function
19+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-rule-value-observable
2+
3+
> JSS plugin for TC39 Observables support
4+
5+
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.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-rule-value-observable
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-rule-value-observable
19+
```
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-template
2+
3+
> JSS plugin enables string templates
4+
5+
See our website [jss-plugin-template](https://cssinjs.org/jss-plugin-template?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-template
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-template
19+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-plugin-vendor-prefixer
2+
3+
> JSS plugin that handles vendor prefixes in the browser
4+
5+
See our website [jss-plugin-vendor-prefixer](https://cssinjs.org/jss-plugin-vendor-prefixer?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-plugin-vendor-prefixer
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-plugin-vendor-prefixer
19+
```

packages/jss-preset-default/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# jss-preset-default
2+
3+
> Default preset for JSS with selected plugins.
4+
5+
See our website [jss-preset-default](https://cssinjs.org/jss-preset-default?v=v10.0.0-alpha.8) for more information.
6+
7+
## Install
8+
9+
Using npm:
10+
11+
```sh
12+
npm install jss-preset-default
13+
```
14+
15+
or using yarn:
16+
17+
```sh
18+
yarn add jss-preset-default
19+
```

packages/jss-starter-kit/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jss-starter-kit",
3-
"description": "A bundle to get you started playing with JSS. Not optimized for production deployment.",
3+
"description": "A bundle to get you started playing with JSS. Not optimized for production deployment.",
44
"version": "10.0.0-alpha.8",
55
"license": "MIT",
66
"homepage": "https://cssinjs.org/",

packages/jss-starter-kit/readme.md

+11-59
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,19 @@
1-
# jss-starter-kit:🚰 the whole kitchen sink
1+
# jss-starter-kit
22

3-
[![Gitter](https://badges.gitter.im/JoinChat.svg)](https://gitter.im/cssinjs/lobby)
3+
> A bundle to get you started playing with JSS. Not optimized for production deployment.
44
5-
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.
5+
See our website [jss-starter-kit](https://cssinjs.org/jss-starter-kit?v=v10.0.0-alpha.8) for more information.
66

7-
:warning: This bundle includes every JSS package, unminified. It's great for experimenting, but not suitable for production deployment.
7+
## Install
88

9-
## Quick start
9+
Using npm:
1010

11-
There's an instance of JSS already set up with all of the default plugins, exported as `jss`.
12-
13-
```javascript
14-
import {jss} from 'https://unpkg.com/jss-starter-kit'
15-
16-
// Notice that you can use camel-cased style keys here, because
17-
// the default preset include jss-plugin-camel-case. If you want to use
18-
// jss in your production application, you'll need to manually install the
19-
// plugins you need.
20-
const {classes} = jss
21-
.createStyleSheet({
22-
wrapper: {
23-
padding: 40,
24-
background: '#f7df1e',
25-
textAlign: 'center'
26-
},
27-
title: {
28-
font: {
29-
size: 40,
30-
weight: 900
31-
},
32-
color: '#24292e'
33-
},
34-
link: {
35-
color: '#24292e',
36-
'&:hover': {
37-
opacity: 0.5
38-
}
39-
}
40-
})
41-
.attach()
42-
43-
document.body.innerHTML = `
44-
<div class="${classes.wrapper}">
45-
<h1 class="${classes.title}">Hello JSS!</h1>
46-
<a
47-
class=${classes.link}
48-
href="http://cssinjs.org/"
49-
traget="_blank"
50-
>
51-
See docs
52-
</a>
53-
</div>
54-
`
11+
```sh
12+
npm install jss-starter-kit
5513
```
5614

57-
## Plugins
58-
59-
[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.
15+
or using yarn:
6016

61-
## Issues
62-
63-
File a bug against [cssinjs/jss prefixed with \[jss-starter-kit\]](https://github.com/cssinjs/jss/issues/new?title=[jss-starter-kit]%20).
64-
65-
## License
66-
67-
MIT
17+
```sh
18+
yarn add jss-starter-kit
19+
```

0 commit comments

Comments
 (0)