History

Felix Kling 84207f2ec8 Use npm version of react-docgen		2015-03-16 15:06:57 -07:00
..
core	Make the publish script faster by not converting all the files on every file	2015-03-15 19:54:14 -07:00
jsdocs	Support flow and @param type hints	2015-03-12 11:36:45 -07:00
layout	[website] Do not absorb spaces in markdown comments	2015-03-16 09:24:33 -07:00
server	Use npm version of react-docgen	2015-03-16 15:06:57 -07:00
src/react-native	[Website] Fix typehint parsing and add header between description and props/methods	2015-03-14 18:10:24 -07:00
.gitignore	Initial version of the automatically generated docs	2015-02-12 14:44:00 -08:00
README.md	[Website] Use postinstall hook to npm install react-docgen	2015-03-13 21:20:55 -07:00
package.json	Use npm version of react-docgen	2015-03-16 15:06:57 -07:00
publish.sh	Trying again...	2015-03-15 20:27:08 -07:00
setup.sh	Attempt at getting Travis CI to automatically push the website	2015-03-15 18:46:48 -07:00

README.md

Run the server

The first time, get all the dependencies loaded via

npm install

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