react-native/website
hansonw 97aad167a6 Fix jsdocs for multi-line ES6-style methods
Summary:
The function definition and body can be in different places for multi-line declarations, so the docblock might not get pulled in. None of the existing docs seem to be affected, but putting up the fix for posterity.

Test Plan:
I modified `AlertIOS.alert` (in Libraries/Utilties/AlertIOS.js) to actually have a docblock, and ran `website/publish.sh` (with the push bit commented out). The added doc doesn't get picked up with the current code, but it does with the fix.
2015-05-14 16:34:55 -07:00
..
core Update website header link github url HTTPS 2015-05-04 00:27:33 -05:00
jsdocs Fix jsdocs for multi-line ES6-style methods 2015-05-14 16:34:55 -07:00
layout Fix issues#1223 2015-05-09 19:05:33 -05:00
server [Docs] Remove Transforms from sidebar, add to Style 2015-05-07 16:05:30 -07:00
src/react-native Merge pull request #665 from yangguang2009/bugfix 2015-05-07 03:39:04 +01:00
.gitignore Initial version of the automatically generated docs 2015-02-12 14:44:00 -08:00
README.md tweak website readme 2015-03-26 10:23:15 -07:00
package.json Fail generating website if any page throws an error 2015-04-01 17:42:33 -07:00
publish.sh Don't try to commit website on Travis if no changes 2015-04-03 09:55:14 -07:00
setup.sh Don't push on Travis before setting password 2015-04-01 18:51:06 -07:00

README.md

Run the website 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