mirror of https://github.com/zhigang1992/react-native.git synced 2026-05-18 04:13:51 +08:00

Files

Christine Abernathy b664e6e734 Update AsyncStorage doc

Summary:
Relates to #8203 for AsyncStorage API update.

- Added a small example to the intro section.
- Added jsdoc format tags to show up class description, parameter descriptions.
- Word-smithed many of the method descriptions.

I also made a bug fix to the autogen. It wasn't handling the scenario where a method may have no parameters.

**Test plan (required)**

Wrote a small sample app to test the snippet added to the intro section.

Ran website locally: http://localhost:8079/react-native/docs/asyncstorage.html

![api_asyncstorage](https://cloud.githubusercontent.com/assets/691109/16329457/84f9d69c-3997-11e6-9e68-3a475df90377.png)

Ran changed files through the linter.
Closes https://github.com/facebook/react-native/pull/8396

Differential Revision: D3481783

Pulled By: JoelMarcey

fbshipit-source-id: ebc4b9695482ada8a3455e621534d2a7fb11edf4

2016-06-24 08:43:36 -07:00

core

Update web player in docs for custom registerComponent names

2016-06-23 17:43:35 -07:00

jsdocs

Improve autogen for reference docs including jsdoc support

2016-06-21 14:28:43 -07:00

layout

Update AsyncStorage doc

2016-06-24 08:43:36 -07:00

server

Bring out prop descriptions, for Flexbox

2016-06-23 16:28:21 -07:00

src/react-native

fix bugs on landing page code, make the url an easter egg

2016-06-23 18:28:23 -07:00

.gitignore

Introduce blog

2016-03-24 14:11:30 -07:00

package.json

Improve autogen for reference docs including jsdoc support

2016-06-21 14:28:43 -07:00

publish-gh-pages.js

fixed website deployment condition logic

2016-04-19 06:43:23 -07:00

README.md

Fix instructions so react-native packages are installed first

2016-06-01 17:58:22 -07:00

setup.sh

Docs for website setup

2015-12-28 12:47:09 -08:00

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

cd website
npm run publish-website