History

Hector Ramos 5be8c4af26 Cleanup stray markdown files, update contributing guidelines Summary: Several changes here. The `Text.md` and `PixelRatio.md` files were appended to the autodocs during site generation. This seemed excessive for just two files, so I've just merged the content into the autodocs themselves. It should help us simplify the website generation process in the future. I've also merged IssueGuidelines.md and PullRequestGuidelines.md into the Contribution/Maintainers guidelines to improve their visibility. Finally, I renamed Help to Community in the nav bar. Ran the website locally, and verified every page rendered as expected: the Community page, Contributing page, Maintainers page. Closes https://github.com/facebook/react-native/pull/15374 Differential Revision: D5567400 Pulled By: hramos fbshipit-source-id: e06056edb12c9a17319fe1af46b2ef3a2e1b5854		2017-08-04 16:18:01 -07:00
..
core	Cleanup stray markdown files, update contributing guidelines	2017-08-04 16:18:01 -07:00
jsdocs	…
layout	…
server	What to Expect from Maintainers	2017-07-28 08:18:53 -07:00
src/react-native	Cleanup stray markdown files, update contributing guidelines	2017-08-04 16:18:01 -07:00
.gitignore	…
README.md	…
package.json	…
publish-gh-pages.js	…
setup.sh	…
showcase.json	…

README.md

Install prerequisites

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

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

cd website
npm install

Then, run the server via

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

The website at https://facebook.github.io/react-native is automatically deployed by our continuous integration infrastructure, specifically CircleCI. This is configured in circle.yml in the root of the repository.