Skip to content
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 6 commits into from
Jan 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions packages/jss-plugin-cache/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-camel-case/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-compose/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-default-unit/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-expand/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-extend/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-global/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-isolate/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-nested/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-props-sort/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-rule-value-function/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-rule-value-observable/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-template/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-plugin-vendor-prefixer/README.md
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
```
19 changes: 19 additions & 0 deletions packages/jss-preset-default/README.md
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
```
2 changes: 1 addition & 1 deletion packages/jss-starter-kit/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jss-starter-kit",
"description": "A bundle to get you started playing with JSS. Not optimized for production deployment.",
"description": "A bundle to get you started playing with JSS. Not optimized for production deployment.",
"version": "10.0.0-alpha.8",
"license": "MIT",
"homepage": "https://cssinjs.org/",
Expand Down
70 changes: 11 additions & 59 deletions packages/jss-starter-kit/readme.md
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`.
Copy link
Member

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


```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
```
Loading