react-native/website/README.md

# Install prerequisites

Before running the website, make sure you've run the following:

```sh
git clone https://github.com/facebook/react-native.git
cd react-native
npm install
```

# Run the website server

The first time, get all the website dependencies loaded via

```sh
cd website
npm install
```

Then, run the server via

```sh
npm start
open http://localhost:8079/react-native/index.html
```

Anytime you change the contents, just refresh the page and it's going to be updated.

# Publish the website

```sh
cd website
npm run publish-website
```
Fix instructions so react-native packages are installed first Summary: Post React 15.x one of the files pulled in for documentation reside in that repo: NativeMethodsMixin.js This ensures that developers install react-native packages first (which includes React) so the file can be found when it's referenced in server/extractDocs.js Test plan (required) 1. Ran through the instructions. 2. Made sure http://localhost:8079/react-native/docs/nativemethodsmixin.html exists in the nav and is shows correctly. Closes https://github.com/facebook/react-native/pull/7882 Differential Revision: D3376395 Pulled By: caabernathy fbshipit-source-id: bfcef271516ed2b21f04d86114dfceb2ff35138c 2016-06-02 00:52:21 +00:00			`# Install prerequisites`

			`Before running the website, make sure you've run the following:`

			```sh
			`git clone https://github.com/facebook/react-native.git`
			`cd react-native`
			`npm install`
			```

tweak website readme 2015-03-26 17:14:24 +00:00			`# Run the website server`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00
Fix instructions so react-native packages are installed first Summary: Post React 15.x one of the files pulled in for documentation reside in that repo: NativeMethodsMixin.js This ensures that developers install react-native packages first (which includes React) so the file can be found when it's referenced in server/extractDocs.js Test plan (required) 1. Ran through the instructions. 2. Made sure http://localhost:8079/react-native/docs/nativemethodsmixin.html exists in the nav and is shows correctly. Closes https://github.com/facebook/react-native/pull/7882 Differential Revision: D3376395 Pulled By: caabernathy fbshipit-source-id: bfcef271516ed2b21f04d86114dfceb2ff35138c 2016-06-02 00:52:21 +00:00			`The first time, get all the website dependencies loaded via`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00
Docs for website setup - always start website/setup.sh in website - use setup.sh in website README 2015-12-28 20:47:09 +00:00			```sh
Fix instructions so react-native packages are installed first Summary: Post React 15.x one of the files pulled in for documentation reside in that repo: NativeMethodsMixin.js This ensures that developers install react-native packages first (which includes React) so the file can be found when it's referenced in server/extractDocs.js Test plan (required) 1. Ran through the instructions. 2. Made sure http://localhost:8079/react-native/docs/nativemethodsmixin.html exists in the nav and is shows correctly. Closes https://github.com/facebook/react-native/pull/7882 Differential Revision: D3376395 Pulled By: caabernathy fbshipit-source-id: bfcef271516ed2b21f04d86114dfceb2ff35138c 2016-06-02 00:52:21 +00:00			`cd website`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00			`npm install`
			```

			`Then, run the server via`

Docs for website setup - always start website/setup.sh in website - use setup.sh in website README 2015-12-28 20:47:09 +00:00			```sh
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00			`npm start`
[Docs] Website - Change port from 8080 to 8079 2015-12-03 18:48:03 +00:00			`open http://localhost:8079/react-native/index.html`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00			```

tweak website readme 2015-03-26 17:14:24 +00:00			`Anytime you change the contents, just refresh the page and it's going to be updated.`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00
			`# Publish the website`

Docs for website setup - always start website/setup.sh in website - use setup.sh in website README 2015-12-28 20:47:09 +00:00			```sh
CI now builds docs website and deploys it to /%version% path Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes https://github.com/facebook/react-native/pull/5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1 2016-02-11 14:16:34 +00:00			`cd website`
			`npm run publish-website`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00			```