mirror of https://github.com/facebook/react-native.git synced 2025-11-01 09:14:26 +00:00

Files

T

Hector Ramos 6ad41a81bc Clean up Animated docs

Summary:
After taking a look at the existing animation docs, I found that most of the documentation on using `Animated` was spread out throughout the Animations guide and the `Animated` API reference, without any particular structure in place.

This PR aims to clean up the API reference, focusing on documenting all the provided methods exhaustively, and deferring to the Animations guide for long form examples and supporting content.

The `Easing` module is referred to at various points in the API reference, so I decided to clean up this doc as well. easings.net provides some handy visualizations that should make it easier for the reader to understand what sort of easing curve each method provides.

The site was built locally, and I verified all three documents render correctly.

![screencapture-localhost-8079-react-native-docs-animations-html-1487212173651](https://cloud.githubusercontent.com/assets/165856/23004694/d3db1670-f3ac-11e6-9d4e-0dd6079b7c5c.png)

Closes https://github.com/facebook/react-native/pull/12410

Differential Revision: D4581314

Pulled By: hramos

fbshipit-source-id: 27c0bce2afac8f084311b9d6113a2641133b42e5

2017-02-17 14:48:17 -08:00

core

fix for being used instead of htmlFor

2016-11-25 19:13:29 -08:00

jsdocs

Replace @provides with @providesModule

2017-02-02 08:58:33 -08:00

layout

RN: Cleanup OSS JS & Flow Declarations

2016-11-20 17:58:29 -08:00

server

Extract docs during static site generation

2017-02-07 14:31:38 -08:00

src/react-native

Clean up Animated docs

2017-02-17 14:48:17 -08:00

.gitignore

Generate Atom feed for the React Native blog.

2016-10-28 13:28:37 -07:00

package.json

Cache docs in memory, speed up page loads during development

2017-02-06 18:31:33 -08:00

publish-gh-pages.js

Deploy showcase, support when building gh-pages on master.

2016-09-20 15:58:48 -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