5a53d90003
fix all anchor links in docs
...
Summary: Closes https://github.com/facebook/react-native/pull/6213
Differential Revision: D2989119
Pulled By: vjeux
fb-gh-sync-id: 3a069dcebbf8dec40702a7bab5268ce4a82db731
shipit-source-id: 3a069dcebbf8dec40702a7bab5268ce4a82db731
2016-02-29 09:21:31 -08:00
fcd468d4eb
fix props anchor links
...
Summary:All anchor links are broken because of https://github.com/facebook/react-native/blob/master/website/core/Site.js#L37 base tag it means that relative urls won't work.
closes #5450
proof
Closes https://github.com/facebook/react-native/pull/6208
Differential Revision: D2988892
Pulled By: vjeux
fb-gh-sync-id: da8b621af92d792a258812e38ae15f7cf53873ca
shipit-source-id: da8b621af92d792a258812e38ae15f7cf53873ca
2016-02-29 07:33:30 -08:00
f73f41779a
Fixed relative links in generated docs
...
Summary:Relative links did not have 'docs/' prefix, so all of them lead to 404 page.
Fixes #5964
Closes https://github.com/facebook/react-native/pull/5975
Differential Revision: D2943886
Pulled By: androidtrunkagent
fb-gh-sync-id: dbc2355ecf7ea4f1dea0f8f6a5ef50e5f324dfda
shipit-source-id: dbc2355ecf7ea4f1dea0f8f6a5ef50e5f324dfda
2016-02-17 07:30:45 -08:00
c6a8fb977d
Fix links to Flexbox / ShadowPropTypesIOS / Transforms in styles
...
Reviewed By: svcscm
Differential Revision: D2938201
fb-gh-sync-id: c20790fa69984f0b592c48fbfdca74f3dfc9d14d
shipit-source-id: c20790fa69984f0b592c48fbfdca74f3dfc9d14d
2016-02-16 02:01:05 -08:00
6f1417c849
CI now builds docs website and deploys it to /%version% path
...
Summary:
Copy of #5760 reverted merge.
We need to preserve history of docs changes on the webserver.
The goal is to allow users to browse outdated versions of docs.
To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut.
I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it.
How it works:
1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder.
Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL.
All relative URLs will work within that website
2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder.
Github will serve this website from https://facebook.github.io/react-native/releases/v
Closes https://github.com/facebook/react-native/pull/5873
Reviewed By: svcscm
Differential Revision: D2926901
Pulled By: androidtrunkagent
fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1
shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
2016-02-11 06:17:42 -08:00
3fbd46c6d9
Cleanup Edit with GitHub
...
Summary:
- Now using a table layout. While having the link inside of the header worked well in the browser, the search API would put "Edit in GitHub" as part of the title -_-
- Instead of putting the link inside of every section like Props, put it on the page header. This makes it less repetetitive and also works on API pages where the link was absent before
- Remove "Run this example" link as there's a giant Run this example sidebar already.
Closes https://github.com/facebook/react-native/pull/5643
Reviewed By: svcscm
Differential Revision: D2883989
Pulled By: vjeux
fb-gh-sync-id: e810e1677d5130692997dd301d6d59cfe04b948f
2016-01-30 23:02:36 -08:00
1c6e837504
Add a deprecatedPropType module to show deprecation warnings
...
Summary:
To allow smoother API changes for users we often deprecate props and keep them around for a while before removing them. Right now it is all done manually, this adds a consistent way to show a warning when using a deprecated prop.
This also adds a deprecation warning of the website generated from the deprecatedPropType.
<img width="643" alt="screen shot 2016-01-26 at 7 43 08 pm" src="https://cloud.githubusercontent.com/assets/2677334/12600172/7af28fb0-c465-11e5-85e5-3786852bf522.png ">
It also changes places where we added the warnings manually to use deprecatedPropType instead.
Closes https://github.com/facebook/react-native/pull/5566
Reviewed By: svcscm
Differential Revision: D2874629
Pulled By: nicklockwood
fb-gh-sync-id: c3c63bae7bbec26cc146029abd9aa5efbe73f795
2016-01-29 02:05:38 -08:00
1154f2a371
Document colors
...
Summary:
<img width="601" alt="screen shot 2016-01-27 at 3 37 22 pm" src="https://cloud.githubusercontent.com/assets/197597/12632329/12084e98-c50c-11e5-96c4-4f56e8219b3b.png ">
<img width="303" alt="screen shot 2016-01-27 at 3 37 16 pm" src="https://cloud.githubusercontent.com/assets/197597/12632328/12075e70-c50c-11e5-95a3-5f483b4dcb47.png ">
<img width="135" alt="screen shot 2016-01-27 at 3 37 38 pm" src="https://cloud.githubusercontent.com/assets/197597/12632327/12067668-c50c-11e5-92f9-ee0c719302b5.png ">
Closes https://github.com/facebook/react-native/pull/5587
Reviewed By: svcscm
Differential Revision: D2878110
Pulled By: vjeux
fb-gh-sync-id: 00330e2857b07aac2e3d3c24f1003cdd9a2516c6
2016-01-28 19:37:33 -08:00
47f863c4da
Single quotes in enum values
...
Summary:
This was driving me crazy :p Turns out that if the value is `'auto' /* default */`, then the docparser will not only trim the comment but also normalize the quote to double quote.
This is not pretty but does the job.
Closes https://github.com/facebook/react-native/pull/5509
Reviewed By: svcscm
Differential Revision: D2872482
Pulled By: vjeux
fb-gh-sync-id: 8ba5dad695f747f82b7680ee26bdc0792e21ea8f
2016-01-27 18:27:01 -08:00
193df8a4e0
Improve style prop display
...
Summary:
- Display the description when it exists
- Display the platform
<img width="667" alt="screen shot 2016-01-24 at 1 37 45 pm" src="https://cloud.githubusercontent.com/assets/197597/12539106/fb226d08-c29f-11e5-83ad-f85bb42ed693.png ">
Closes https://github.com/facebook/react-native/pull/5520
Reviewed By: svcscm
Differential Revision: D2859743
Pulled By: vjeux
fb-gh-sync-id: 0ccfeca7bbdfa837501378c0bf701d589fea48d8
2016-01-25 09:53:29 -08:00
847220957a
Add "Edit on GitHub" link on normal docs pages
...
Summary:
<img width="938" alt="screen shot 2016-01-20 at 10 38 23 pm" src="https://cloud.githubusercontent.com/assets/197597/12473376/8f0ac970-bfc6-11e5-9e44-0481e9f250f1.png ">
Closes https://github.com/facebook/react-native/pull/5454
Reviewed By: svcscm
Differential Revision: D2849235
Pulled By: vjeux
fb-gh-sync-id: 0103f3d5249b1dfc03aa77feb9ae3bb7bbe9c746
2016-01-20 23:47:33 -08:00
cb609f986c
Remove indentation and force appetize link to open a new window/tab
2015-10-15 18:18:01 +03:00
080746c4c3
Add hover effect and appetize link
2015-10-14 23:04:31 +03:00
d9ee81c127
embed an appetize.io simulator for AlertIOS documentation
2015-10-14 19:57:23 +02:00
dfdef9a02a
[autodocs] add doc blocks to more things
2015-09-03 11:53:20 -07:00
126928b0b4
[Docs] Expand API parsing and rendering
...
The `Animated` module exposes a lot of functionality, including internal
classes. This diff extracts properties and classes from modules and renders them
recursively.
This also adds `Animated` to the autogen docs now that they more capable,
although it needs way more docblocks and such which will come later.
2015-09-01 14:14:47 -07:00
c1a0a72275
[Website] Fix a-z order in props
2015-08-08 10:28:05 -07:00
6e9ceaa348
[Website] Platform-specific props
...
We are annotating platform-specific props with a special @platform tag in the docblocks. This pull request adds a little [ios] tag before the name and sorts the props such as generic ones are before platform-specific ones.
2015-08-07 10:31:07 -07:00
129d1548a8
Add dynamic page title
...
Currently all the pages have the same title, making it hard to
tell which page is while when user has multiple tabs opened.
This adds 'title' to Site so a page title can be passed in and
prepended to the default title
2015-08-02 22:07:53 +08:00
5af8849aa4
[Docs] Add a 'run this example' link to AlertIOS docs, plus supporting code to add more links progressively
2015-06-30 23:39:49 +02:00
38c5be59b8
Fix issues#1223
2015-05-09 19:05:33 -05:00
b8ca4e450b
Add TransformPropTypes to docs
2015-05-07 12:16:48 -07:00
42d4de9ce0
Remove unnecessary newline
2015-05-07 11:56:42 -07:00
f878be84e6
Clarify transform for ViewStyleProps, generate union docs properly
2015-05-07 11:56:42 -07:00
2d7c5c4746
Fail docs build on missing component file
...
This would have prevented #709 .
2015-04-06 15:23:06 -07:00
7a165db177
Use greedy regex for removing docblock
2015-04-01 08:54:20 -07:00
a4a551c571
Add examples at the end of the doc pages
2015-03-31 12:28:53 -07:00
536b4669a3
Add Edit on Github link on pages. cc @DMortens
2015-03-31 10:10:05 -07:00
17fb98ea85
[docs] Fix 0 being rendered on functions with 0 args
2015-03-26 09:15:45 +00:00
00f2a7b016
Avoid empty methods section in docs
2015-03-25 14:26:56 -07:00
6271f81a60
Don't document private methods
2015-03-25 12:39:57 -07:00
c676e9dccc
Rename LayoutPropTypes to Flexbox
2015-03-24 09:24:15 -07:00
d5f670d19c
Add logic to show style props in docs
2015-03-23 11:34:20 -07:00
e811181034
Add copyright header on website files
2015-03-23 10:56:09 -07:00
e2e123c2ab
Random changes in the website
2015-03-19 13:55:59 -07:00
85a13b48eb
[website] Do not absorb spaces in markdown comments
2015-03-16 09:24:33 -07:00
032449c54c
[Website] Fix typehint parsing and add header between description and props/methods
2015-03-14 18:10:24 -07:00
28aa691d13
Updates from Fri 13 Mar
...
- [ReactNative] Oss ActionSheet | Tadeu Zagallo
- [ReactNative] Fix ScrollView.scrollTo() | Christopher Chedeau
- [catalyst|madman] fix location observer | Jiajie Zhu
- [ReactNative] Remove keyboardDismissMode from static | Christopher Chedeau
- [ReactNative] Fix RCTMapManager retaining cycle | Tadeu Zagallo
- [ReactNative] Support loading sourcemaps from sourceMappingURL | Alex Kotliarskyi
- [catalyst] set up directory specific rql transform | Bhuwan Khattar
- [React Native] Add .done() to terminate promise chains | Ben Alpert
- [React Native] add support for reading tracking bit | Owen Coutts
2015-03-13 15:30:31 -07:00
9f37aea739
Support flow and @param type hints
2015-03-12 11:36:45 -07:00
33bfb322ad
Wire up jsdocs for apis
2015-03-12 11:04:06 -07:00
05ec075c94
[Website] Better summary for propTypes
2015-03-09 13:25:01 -07:00
f87b0cb495
[Website] Add a link when composing prop types
2015-03-09 11:59:26 -07:00
b9ab607197
Use docs/ComponentName.md at the end of the component docs
2015-03-04 21:03:24 -08:00
d935f4554b
Improvements in the docs generation
2015-03-04 18:10:32 -08:00
9231d4f8f0
Initial version of the website and docs.
2015-02-11 20:26:43 -08:00
Sokovikov
Konstantin Raev
Brent Vatne
Christopher Chedeau
Janic Duplessis
Johan Ruokangas
Joshua Sierles
Spencer Ahrens
Mu-An Chiou
Zhao Han
Brent Vatne
Ben Alpert
Tadeu Zagallo
Eric Vicenti
Felix Kling
