Skip to content

Commit 1ac1072

Browse files
committed
Fix syntax in markdown files
1 parent 8fabf6d commit 1ac1072

16 files changed

+34
-29
lines changed

.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,11 @@ translated_docs/
88

99
i18n/*
1010
!i18n/en.json
11+
12+
# Yarn
13+
.yarn/*
14+
!.yarn/patches
15+
!.yarn/plugins
16+
!.yarn/releases
17+
!.yarn/sdks
18+
!.yarn/versions

blog/2018-04-06-react-navigation-2.0-rc.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Exactly two months after the release of React Navigation 1.0, we are close to an
1515
yarn add react-navigation@^2.0.0-rc.1
1616
```
1717

18-
The documentation for 2.0 is available at <https://reactnavigation.org/>
18+
The documentation for 2.0 is available at [reactnavigation.org](https://reactnavigation.org)
1919

2020
We’re bumping the major version because some of the changes in this release are backwards incompatible. That said, this should be a fairly easy upgrade. We are improving React Navigation incrementally because we don't want to leave developers feeling stranded in an old version. If you use React Navigation in a conventional way and don't have any custom navigators, I can't imagine this update would take you more than an hour.
2121

@@ -77,5 +77,5 @@ This change was made to improve the ease of learning and understanding the libra
7777
## New feature highlights
7878

7979
- State persistence - automatically save state and reload it when the app restarts. See [state persistence docs](docs/state-persistence)
80-
- Transitions between screens in stack with headers and without headers now animates as expected on iOS. <https://github.com/react-navigation/react-navigation/pull/3821>. Thanks [skevy](https://github.com/skevy)!
80+
- Transitions between screens in stack with headers and without headers now animates as expected on iOS. [#3821](https://github.com/react-navigation/react-navigation/pull/3821). Thanks [skevy](https://github.com/skevy)!
8181
- As mentioned above, `createMaterialBottomNavigator` is a new navigator type that provides the material design bottom tab bar pattern.

blog/2018-05-07-react-navigation-2.0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
77
tags: [release, announcement]
88
---
99

10-
The documentation is now live at <https://reactnavigation.org>, and v1 lives [here](/docs/1.x/getting-started).
10+
The documentation is now live at [reactnavigation.org](https://reactnavigation.org), and v1 lives [here](/docs/1.x/getting-started).
1111

1212
<!--truncate-->
1313

blog/2018-11-01-react-navigation-3.0-rc.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ First, install the library using your favorite package manager: `yarn add react-
2323

2424
Next, install react-native-gesture-handler. If you’re using Expo you don’t need to do anything here, it’s included in the SDK. Otherwise: `yarn add react-native-gesture-handler && react-native link`
2525

26-
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on <https://github.com/kmagiera/react-native-screens>.
26+
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on [`react-native-screens`](https://github.com/software-mansion/react-native-screens).
2727

2828
> **Warning**: if you have manually installed any navigators in your project, for example react-navigation-material-bottom-tabs, you will need to update those to a version that is compatible with 3.0.0. In the case of react-navigation-material-bottom-tabs, 1.0.0-alpha.2 is compatible.
2929
@@ -133,15 +133,15 @@ const Store = createStackNavigator({
133133
- Basic support for hooks in `react-navigation-hooks`
134134
- `headerBackgroundTransitionPreset: 'toggle' | 'fade' | 'translate'` lets you choose how to transition your custom `headerBackground` components between screens.
135135
- Add options to opt in/out of the stack card overlay and shadow that are visible during transitions: `cardShadowEnabled` defaults to `true` and `cardOverlayEnabled` defaults to `false`.
136-
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: <https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js>).
136+
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: [GestureInteraction.js](https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js)).
137137

138138
## Assorted fixes & improvements
139139

140140
- Stack transition performance improved greatly by removing the shadow from the entire card and rendering it only on the slice where it is needed. The card opacity is also no longer directly animated but instead an overlay is put on top to create a similar effect but with better performance.
141-
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: <https://github.com/react-navigation/react-navigation/issues/4155>
141+
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: [react-navigation/issues/415](https://github.com/react-navigation/react-navigation/issues/4155)
142142
- Support inverted gesture in modals.
143143
- Stack card gesture uses react-native-gesture-handler and native driver so the gesture runs on the UI thread (except when the gesture ends, then it calls back to JS).
144-
- Fix a variety of issues with drawer navigator, including issues around nesting (<https://github.com/react-navigation/react-navigation/issues/4154>) and bugs with firing open / close (eg: <https://github.com/react-navigation/react-navigation/issues/5146>).
144+
- Fix a variety of issues with drawer navigator, including issues around nesting ([react-navigation/issues/4154](https://github.com/react-navigation/react-navigation/issues/4154)) and bugs with firing open / close (eg: [react-navigation/issues/5146](https://github.com/react-navigation/react-navigation/issues/5146)).
145145

146146
## Ecosystem and web support
147147

@@ -215,4 +215,4 @@ See a simple web app with Create React App [here](https://github.com/react-navig
215215
216216
----------
217217
218-
Thanks for reading, please post any issues you encounter to <https://github.com/react-navigation/react-navigation/issues>!
218+
Thanks for reading, please post any issues you encounter to [react-navigation/issues](https://github.com/react-navigation/react-navigation/issues)!

blog/2018-11-17-react-navigation-3.0.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
77
tags: [release, announcement]
88
---
99

10-
The documentation is now live at <https://reactnavigation.org>, and v2 lives [here](/docs/2.x/getting-started).
10+
The documentation is now live at [reactnavigation.org](https://reactnavigation.org), and v2 lives [here](/docs/2.x/getting-started).
1111

1212
This is the first release where React Navigation depends on a native module outside of React Native core: it now depends on react-native-gesture-handler. This library provides an excellent set of primitives for leveraging the operating systems’ native gesture APIs and has enabled us to fix a variety of issues with stack and drawer navigators. React Navigation also depends on react-native-screens, but you don’t need to install the native module if you prefer not to use it (we have a blog post coming soon that will explain what react-native-screens is and why you may want to use it, or you can watch [this talk](https://www.youtube.com/watch?v=Z0Jl1KCWiag) by the author of the library).
1313

@@ -23,7 +23,7 @@ First, install the library using your favorite package manager: `yarn add react-
2323

2424
Next, install react-native-gesture-handler. If you’re using Expo you don’t need to do anything here, it’s included in the SDK. Otherwise, follow [these installation instructions](https://kmagiera.github.io/react-native-gesture-handler/docs/getting-started.html#installation).
2525

26-
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on <https://github.com/kmagiera/react-native-screens>.
26+
Optionally, you can install react-native-screens. If you’re using Expo you don’t need to do anything here, it’s included in SDK 30 and higher. Otherwise, follow the instructions in the README on [`react-native-screens`](https://github.com/software-mansion/react-native-screens).
2727

2828
> **Warning**: if you have manually installed any navigators in your project, for example react-navigation-material-bottom-tabs, you will need to update those to a version that is compatible with 3.0.0. In the case of react-navigation-material-bottom-tabs, 1.0.0 is compatible.
2929
@@ -150,16 +150,16 @@ const Store = createStackNavigator({
150150
- Basic support for hooks in `react-navigation-hooks` (although this isn't too useful yet without a stable react-native build that supports hooks, you can play with it on the web!).
151151
- `headerBackgroundTransitionPreset: 'toggle' | 'fade' | 'translate'` lets you choose how to transition your custom `headerBackground` components between screens.
152152
- Add options to opt in/out of the stack card overlay and shadow that are visible during transitions: `cardShadowEnabled` defaults to `true` and `cardOverlayEnabled` defaults to `false`.
153-
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: <https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js>).
153+
- Export `StackGestureContext` and `DrawerGestureContext` from react-navigation-stack and react-navigation-drawer, so you can use the ref from the corresponding gestures with other gesture handlers (eg: [GestureInteraction.js](https://github.com/react-navigation/react-navigation-drawer/blob/bf4bdba7f6a4fbc12192f5d5ba2285f6280431b7/example/src/GestureInteraction.js)).
154154
- Tab navigators support `tabBarOnLongPress` configuration option, which defaults to the same as the tab press event.
155155

156156
## Assorted fixes & improvements
157157

158158
- Stack transition performance improved greatly by removing the shadow from the entire card and rendering it only on the slice where it is needed. The card opacity is also no longer directly animated but instead an overlay is put on top to create a similar effect but with better performance.
159-
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: <https://github.com/react-navigation/react-navigation/issues/4155>
159+
- Fix long-standing issues with stack that led to quietly re-mounting screens when navigating quickly in certain patterns: [react-navigation/issues/4155](https://github.com/react-navigation/react-navigation/issues/4155)
160160
- Support inverted gesture in modals.
161161
- Stack card gesture uses react-native-gesture-handler and native driver so the gesture runs on the UI thread (except when the gesture ends, then it calls back to JS).
162-
- Fix a variety of issues with drawer navigator, including issues around nesting (<https://github.com/react-navigation/react-navigation/issues/4154>) and bugs with firing open / close (eg: <https://github.com/react-navigation/react-navigation/issues/5146>).
162+
- Fix a variety of issues with drawer navigator, including issues around nesting ([react-navigation/issues/4154](https://github.com/react-navigation/react-navigation/issues/4154)) and bugs with firing open / close (eg: [react-navigation/react-navigation/issues/5146](https://github.com/react-navigation/react-navigation/issues/5146)).
163163
- Fix accessibility voiceover for tabs and stack back button.
164164

165165
## Ecosystem and web support
@@ -234,4 +234,4 @@ See a simple web app with Create React App [here](https://github.com/react-navig
234234
235235
---
236236
237-
Thanks for reading, please post any issues you encounter to <https://github.com/react-navigation/react-navigation/issues>!
237+
Thanks for reading, please post any issues you encounter to [react-navigation/issues](https://github.com/react-navigation/react-navigation/issues)!

blog/2019-09-16-react-navigation-4.0.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author_image_url: https://avatars2.githubusercontent.com/u/1174278?s=200&v=4
77
tags: [release, announcement]
88
---
99

10-
The documentation is now live at <https://reactnavigation.org>, and v3 lives [here](/docs/3.x/getting-started).
10+
The documentation is now live at [reactnavigation.org](https://reactnavigation.org), and v3 lives [here](/docs/3.x/getting-started).
1111

1212
In this release, we have removed the navigators from the react-navigation package. The navigators have lived in separate packages for quite a while and you could already use those packages manually, but we still bundled them in the react-navigation package. This made it difficult for us to release significant updates to navigators, because we had to then do a major version release of react-navigation too. By separating the navigator packages there is more freedom to update and improve navigators without any impact on folks that don't use them.
1313

@@ -29,4 +29,4 @@ If you're using TypeScript, navigator specific types were also removed from the
2929

3030
---
3131

32-
Thanks for reading, please post any issues you encounter to <https://github.com/react-navigation/react-navigation/issues>!
32+
Thanks for reading, please post any issues you encounter to [react-navigation/issues](https://github.com/react-navigation/react-navigation/issues)!

versioned_docs/version-1.x/stack-navigator.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ Visual options:
6262
* `fade-in-place` - Header components cross-fade without moving, similar to the Twitter, Instagram, and Facebook app for iOS. This is the default value.
6363
* `uikit` - An approximation of the default behavior for iOS.
6464
* `cardStyle` - Use this prop to override or extend the default style for an individual card in stack.
65-
* `transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](
66-
<https://github.com/react-navigation/react-navigation/blob/1.x/flow/react-navigation.js>)). Provided function will be passed the following arguments:
65+
* `transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](https://github.com/react-navigation/react-navigation/blob/1.x/flow/react-navigation.js)). Provided function will be passed the following arguments:
6766
* `transitionProps` - Transition props for the new screen.
6867
* `prevTransitionProps` - Transitions props for the old screen.
6968
* `isModal` - Boolean specifying if screen is modal.

versioned_docs/version-2.x/custom-navigators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To help developers implement custom navigators, the following utilities are prov
9696

9797
### `createNavigator`
9898

99-
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: <https://v1.reactnavigation.org/docs/custom-navigators.html>
99+
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: [v1.reactnavigation.org/docs/custom-navigators.html](https://v1.reactnavigation.org/docs/custom-navigators.html)
100100
101101
This utility combines a [router](routers.md) and a [navigation view](navigation-views.md) together in a standard way:
102102

versioned_docs/version-2.x/stack-navigator.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ Visual options:
6868
* `left` - Anchor the title to the left, near the back button or other left component. This is the default on Android. When used on iOS, the header back title is hidden. Content from the left component will overflow underneath the title, if you need to adjust this you can use `headerLeftContainerStyle` and `headerTitleContainerStyle`. Additionally, this alignment is incompatible with `headerTransitionPreset: 'uikit'`.
6969
* `center` - Center the title, this is the default on iOS.
7070
* `cardStyle` - Use this prop to override or extend the default style for an individual card in stack.
71-
* `transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](
72-
<https://github.com/react-navigation/react-navigation/blob/2.x/flow/react-navigation.js>)). Provided function will be passed the following arguments:
71+
* `transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](https://github.com/react-navigation/react-navigation/blob/2.x/flow/react-navigation.js)). Provided function will be passed the following arguments:
7372
* `transitionProps` - Transition props for the new screen.
7473
* `prevTransitionProps` - Transitions props for the old screen.
7574
* `isModal` - Boolean specifying if screen is modal.

versioned_docs/version-3.x/custom-navigators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To help developers implement custom navigators, the following utilities are prov
9696

9797
### `createNavigator`
9898

99-
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: <https://v1.reactnavigation.org/docs/custom-navigators.html>
99+
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: [v1.reactnavigation.org/docs/custom-navigators.html](https://v1.reactnavigation.org/docs/custom-navigators.html)
100100
101101
This utility combines a [router](routers.md) and a [navigation view](navigation-views.md) together in a standard way:
102102

versioned_docs/version-3.x/redux-integration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Redux integration
44
sidebar_label: Redux integration
55
---
66

7-
It is extremely easy to use Redux in an app with React Navigation. It's basically no different than without React Navigation. The following example shows how to do it end to end: <https://snack.expo.io/@react-navigation/redux-example>. The most important piece from it is the following:
7+
It is extremely easy to use Redux in an app with React Navigation. It's basically no different than without React Navigation. The following example shows how to do it end to end: [snack.expo.io/@react-navigation/redux-example](https://snack.expo.io/@react-navigation/redux-example). The most important piece from it is the following:
88

99
```js
1010
let RootStack = createStackNavigator({

versioned_docs/version-3.x/stack-navigator.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ Visual options:
7272
* `cardStyle` - Use this prop to override or extend the default style for an individual card in stack.
7373
* `cardShadowEnabled` - Use this prop to have visible shadows during transitions. Defaults to `true`
7474
* `cardOverlayEnabled` - Use this prop to have visible stack card overlays during transitions. Defaults to `false`.
75-
* `transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](
76-
<https://github.com/react-navigation/react-navigation/blob/3.x/flow/react-navigation.js>)). Provided function will be passed the following arguments:
75+
* `transitionConfig` - Function to return an object that is merged with the default screen transitions (take a look at TransitionConfig in [type definitions](https://github.com/react-navigation/react-navigation/blob/3.x/flow/react-navigation.js)). Provided function will be passed the following arguments:
7776
* `transitionProps` - Transition props for the new screen.
7877
* `prevTransitionProps` - Transitions props for the old screen.
7978
* `isModal` - Boolean specifying if screen is modal.

versioned_docs/version-4.x/custom-navigators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To help developers implement custom navigators, the following utilities are prov
9696

9797
### `createNavigator`
9898

99-
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: <https://v1.reactnavigation.org/docs/custom-navigators.html>
99+
> Note: The `createNavigator` API has changed in version 2. The old doc for v1 can be accessed here: [v1.reactnavigation.org/docs/custom-navigators.html](https://v1.reactnavigation.org/docs/custom-navigators.html)
100100
101101
This utility combines a [router](routers.md) and a [navigation view](navigation-views.md) together in a standard way:
102102

0 commit comments

Comments
 (0)