mirror of
https://github.com/zhigang1992/react-native.git
synced 2026-02-09 22:50:21 +08:00
97aad167a6
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.
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