2bca6acdaf
Summary: When looking at PropType information for certain props the formatting puts everything on one line which makes it quite hard to read. This PR ensures that the whitespace extracted from react-docgen is preserved. For example the documentation for [Transforms](http://facebook.github.io/react-native/releases/0.34/docs/transforms.html#transform) goes from: <img width="717" alt="screenshot 2016-10-01 17 32 23" src="https://cloud.githubusercontent.com/assets/691952/19015498/74aaa5c8-87fd-11e6-922d-3eef38cc6452.png"> to: <img width="707" alt="screenshot 2016-10-01 17 32 30" src="https://cloud.githubusercontent.com/assets/691952/19015500/784521a4-87fd-11e6-9c23-717d1ee31921.png"> **Test plan:** Check PropType documentation is being rendered correctly on other components. **N.B.** more style tweaks could be made here to make things more readable (e.g. reducing line height, monospace font) but I'll refrain from making them here in case there are explicit designs for the docs. Closes https://github.com/facebook/react-native/pull/10197 Differential Revision: D3967759 Pulled By: hramos fbshipit-source-id: bf3d3b2032dc6e9f5f1acf3907ecb7f57a2c57be |
||
---|---|---|
.. | ||
core | ||
jsdocs | ||
layout | ||
server | ||
src/react-native | ||
.gitignore | ||
README.md | ||
package.json | ||
publish-gh-pages.js | ||
setup.sh |
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