History

Christopher Chedeau 33bfb322ad Wire up jsdocs for apis		2015-03-12 11:04:06 -07:00
..
core	Use docs/ComponentName.md at the end of the component docs	2015-03-04 21:03:24 -08:00
jsdocs	Wire up jsdocs for apis	2015-03-12 11:04:06 -07:00
layout	Wire up jsdocs for apis	2015-03-12 11:04:06 -07:00
react-docgen	Update react-docgen	2015-03-05 00:37:02 -08:00
server	Wire up jsdocs for apis	2015-03-12 11:04:06 -07:00
src/react-native	Improvements in the docs generation	2015-03-04 18:10:32 -08:00
.gitignore	Initial version of the automatically generated docs	2015-02-12 14:44:00 -08:00
README.md	Add the temporary react-docgen instruction	2015-03-05 09:26:32 +01:00
package.json	Wire up jsdocs for apis	2015-03-12 11:04:06 -07:00
publish.sh	Initial version of the website and docs.	2015-02-11 20:26:43 -08:00

README.md

Run the server

The first time, get all the dependencies loaded via

npm install

You also have to run npm install inside the react-docgen folder. This is only temporary until react-docgen is available as npm module.

cd react-docgen
npm install
cd ..

Then, run the server via

npm start
Open http://localhost:8080/react-native/index.html

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

Publish the website

First setup your environment by having two folders, one react-native and one react-native-gh-pages. The publish script expects those exact names.

cd ../../
git clone git@github.com:facebook/react-native.git react-native-gh-pages
cd react-native-gh-pages
git checkout origin/gh-pages
git checkout -b gh-pages
git push --set-upstream origin gh-pages
cd ../react-native/website

Then, after you've done changes, just run the command and it'll automatically build the static version of the site and publish it to gh-pages.

./publish.sh