next.js/examples/with-styled-components/README.md

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-styled-components)

# Example app with styled-components

## How to use

### Using `create-next-app`

Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:

```bash
npx create-next-app --example with-styled-components with-styled-components-app
# or
yarn create next-app --example with-styled-components with-styled-components-app
```

### Download manually

Download the example:

```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-styled-components
cd with-styled-components
```

Install it and run:

```bash
npm install
npm run dev
# or
yarn
yarn dev
```

Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))

```bash
now
```

## The idea behind the example

This example features how you use a different styling solution than [styled-jsx](https://github.com/zeit/styled-jsx) that also supports universal styles. That means we can serve the required styles for the first render within the HTML and then load the rest in the client. In this case we are using [styled-components](https://github.com/styled-components/styled-components).

For this purpose we are extending the `<Document />` and injecting the server side rendered styles into the `<head>`.
Add deploy now button to the top of all example READMEs (#1763) * Add deploy now button to the top of all example READMEs * Remove unnecessary whitespace changes 2017-04-22 12:51:51 +00:00			`[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-styled-components)`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
examples: fix README titles 2016-12-22 22:57:57 +00:00			`# Example app with styled-components`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			`## How to use`

examples: add create-next-app (#3377) * examples: add create-next-app * fix with-typescript readme 2017-12-03 04:30:17 +00:00			### Using `create-next-app`

Examples: stabalise README format and create-next-app usage (#4009) * Examples: clarify language around Yarn create & npx * add missing READMEs and create-next-app usage * suggest people tag jthegedus in firebase related issues * add yarn alt instructions * cerebraljs example readme & fixes 2018-04-03 12:19:05 +00:00			Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
examples: add create-next-app (#3377) * examples: add create-next-app * fix with-typescript readme 2017-12-03 04:30:17 +00:00
Examples: use npx and yarn create to run create-next-app on examples (#4002) * remove global npm install of create-next-app * add npx to create-next-app command in examples * add bash to shell snippets * add yarn create to next-app command in examples * fix READMEs named with lowercase * change READMEs to use UPPERCASE 2018-03-14 08:09:46 +00:00			```bash
			`npx create-next-app --example with-styled-components with-styled-components-app`
			`# or`
			`yarn create next-app --example with-styled-components with-styled-components-app`
examples: add create-next-app (#3377) * examples: add create-next-app * fix with-typescript readme 2017-12-03 04:30:17 +00:00			```

			`### Download manually`

#4751 - Explicitly mention install when cloning examples (#4758) Preferably this installation wouldn't be necessary, but in lieu of a fix... #4751 2018-07-11 21:56:15 +00:00			`Download the example:`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			```bash
Use canary for all example downloads (#3411) 2017-12-07 02:12:42 +00:00			`curl https://codeload.github.com/zeit/next.js/tar.gz/canary \| tar -xz --strip=2 next.js-canary/examples/with-styled-components`
examples: simplify download instruction 2016-12-22 09:07:54 +00:00			`cd with-styled-components`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00			```

Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`Install it and run:`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			```bash
			`npm install`
Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`npm run dev`
Examples: stabalise README format and create-next-app usage (#4009) * Examples: clarify language around Yarn create & npx * add missing READMEs and create-next-app usage * suggest people tag jthegedus in firebase related issues * add yarn alt instructions * cerebraljs example readme & fixes 2018-04-03 12:19:05 +00:00			`# or`
			`yarn`
			`yarn dev`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00			```

Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			```bash
Add/data fetch example (#485) * Added data fetch example * Finished updating examples install instructions and added data-fetch example to main readme 2016-12-22 23:05:49 +00:00			`now`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00			```

			`## The idea behind the example`

Update README.md (#687) 2017-01-07 00:19:07 +00:00			`This example features how you use a different styling solution than [styled-jsx](https://github.com/zeit/styled-jsx) that also supports universal styles. That means we can serve the required styles for the first render within the HTML and then load the rest in the client. In this case we are using [styled-components](https://github.com/styled-components/styled-components).`
Add/move examples (#470) * Added redux and styled components (wip) examples. * Updated examples readmes and package.json * Fixed styled-components example 2016-12-22 05:10:54 +00:00
			For this purpose we are extending the `<Document />` and injecting the server side rendered styles into the `<head>`.