Add markdownlint

Author: satya164

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
-# READ ME PLEASE!
+# READ ME PLEASE
 
-### TL;DR: Make sure to add your changes to versioned docs
+> **TL;DR: Make sure to add your changes to versioned docs**
 
 Thanks for opening a PR!
 

.github/workflows/autofix.yml

@@ -0,0 +1,28 @@
+name: autofix.ci
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  autofix:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup
+        uses: ./.github/actions/setup
+
+      - name: Fix lint issues
+        run: yarn markdownlint-cli2-fix
+
+      - name: Autofix
+        uses: autofix-ci/action@8106fde54b877517c9af2c3d68918ddeaa7bed64

.github/workflows/ci.yml

@@ -14,5 +14,8 @@ jobs:
       - name: Setup
         uses: ./.github/actions/setup
 
+      - name: Lint markdown
+        run: yarn markdownlint-cli2
+
       - name: Build pages
         run: yarn build

.markdownlint-cli2.yaml

@@ -0,0 +1,8 @@
+globs:
+  - '**/*.md'
+ignores:
+  - node_modules
+  - versioned_docs/version-1.x
+  - versioned_docs/version-2.x
+  - versioned_docs/version-3.x
+  - versioned_docs/version-4.x

.markdownlint.yaml

@@ -0,0 +1,7 @@
+default: true
+
+# Disable checks for line length
+MD013: false
+
+# Disable checks for inline HTML
+MD033: false

README.md

@@ -1,5 +1,4 @@
-<h2 align="center"><a href="https://reactnavigation.org/"> <img src="static/img/react_navigation_header.png" width="400" /> </a></h2>
-
+<h1 align="center"><a href="https://reactnavigation.org/"> <img src="static/img/react_navigation_header.png" width="400" /> </a></h1>
 
 Want to help improve the documentation? That would be so very much appreciated. Some information on that below.
 
@@ -52,4 +51,5 @@ yarn deploy
 ```
 
 ## License
-[MIT License](LICENSE)
+
+[MIT License](LICENSE)

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

@@ -11,11 +11,11 @@ Exactly two months after the release of React Navigation 1.0, we are close to an
 
 <!--truncate-->
 
-```
+```sh
 yarn add react-navigation@^2.0.0-rc.1
 ```
 
-The documentation for 2.0 is available at https://reactnavigation.org/
+The documentation for 2.0 is available at <https://reactnavigation.org/>
 
 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.
 
@@ -63,7 +63,7 @@ The following APIs are deprecated and will be removed in 3.0.
 
 ### XNavigator is now named createXNavigator
 
-```
+```js
 import { createStackNavigator } from ‘react-navigation’;
 createStackNavigator({routeName: Screen});
 ```
@@ -77,5 +77,5 @@ This change was made to improve the ease of learning and understanding the libra
 ## New feature highlights
 
 - State persistence - automatically save state and reload it when the app restarts. See [state persistence docs](docs/state-persistence)
-- 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)!
+- 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)!
 - 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

@@ -7,7 +7,7 @@ author_image_url: https://avatars0.githubusercontent.com/u/90494?s=200&v=4
 tags: [release, announcement]
 ---
 
-The documentation is now live at https://reactnavigation.org, and v1 lives [here](/docs/1.x/getting-started).
+The documentation is now live at <https://reactnavigation.org>, and v1 lives [here](/docs/1.x/getting-started).
 
 <!--truncate-->
 
@@ -63,7 +63,7 @@ Given that we only exposed generic helpers (`navigate`, `goBack`) and helpers sp
 
 One of the big improvements you get from this is that you can now add your own helpers to the `navigation` prop!  Read more in [RFC 6](https://github.com/react-navigation/rfcs/blob/master/text/0006-action-creators.md) and in [pull 3392](https://github.com/react-navigation/react-navigation/pull/3392).
 
- ### NavigationActions no longer have `toString()` implementations ([related](https://github.com/react-navigation/react-navigation/issues/4072))
+### NavigationActions no longer have `toString()` implementations ([related](https://github.com/react-navigation/react-navigation/issues/4072))
 
 This change was intended to simplify the implementation of actions. We may go back on this, however, and apologize in advance if this thrasing causes you trouble.
 
@@ -73,7 +73,7 @@ If you are using `NavigationActions.push` or other stack-specific actions, you
 
 ## Deprecations
 
-###  XNavigator(...) is now createXNavigator(...)
+### XNavigator(...) is now createXNavigator(...)
 
 `StackNavigator`, `TabNavigator` and `DrawerNavigator` are now deprecated in favour of `createStackNavigator`, `createTabNavigator`, and `createDrawerNavigator`, which are functionally identical but more clearly communicate that they are functions and that they return a component. The `XNavigator` style will removed in 3.0.
 

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

@@ -17,22 +17,21 @@ We didn’t get around to every feature that we wanted to land for this release,
 
 Let’s get started with react-navigation 3.0.
 
-# Installation
+## Installation
 
 First, install the library using your favorite package manager: `yarn add react-navigation@^3.0.0-rc.0`
 
 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`
 
-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.
+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>.
 
 > **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.
 
-# Breaking changes
+## Breaking changes
 
 When you first run your app after updating it won’t work because react-navigation@^3 requires you to add an app container to the root navigator. Once you get that in place, you may notice that your navigation options aren’t being applied as you expect - this is due to navigationOptions in navigator configuration being renamed to defaultNavigationOptions. If you use a drawer, you may notice that it feels quicker, but if you depend on inactive screens being unmounted you’ll be surprised. More details on these changes and how to update your app to work just as well (probably better) than before below.
 
-
-## Explicit app container required for the root navigator
+### Explicit app container required for the root navigator
 
 In the past, any navigator could act as the navigation container at the top-level of your app because they were all wrapped in “navigation containers”. The navigation container, now known as an app container, is a higher-order-component that maintains the navigation state of your app and handles interacting with the outside world to turn linking events into navigation actions and so on.
 
@@ -49,7 +48,7 @@ This should be an easy change - import `createAppContainer` in the root of your
 
 > **Warning**: if you have any custom navigators, you may have used  `createNavigationContainer`, you can remove this now because it’s only used at the root of the app and provided by the user.
 
-## Renamed navigationOptions in navigator configuration
+### Renamed navigationOptions in navigator configuration
 
 When configuring navigators it’s often useful to pass in default navigation options for the screens inside of that navigator. For example in a stack you might want to set a background color and tint color for each screen. Previously, you would write something like this:
 
@@ -85,7 +84,6 @@ const Home = createStackNavigator({
 
 Sometimes you need to configure the `navigationOptions` for a navigator itself. Typically you’d do something like this:
 
-
 ```js
 Home.navigationOptions = { tabBarLabel: 'Home!' };
 ```
@@ -115,11 +113,11 @@ const Tabs = createBottomTabNavigator({ Home });
 
 We’re sorry to make you go hunt through your code and rename a handful of strings, the hope is that this change makes the code more readable and more intuitive to new users in the future.
 
-## Drawer now keeps inactive tabs in memory by default
+### Drawer now keeps inactive tabs in memory by default
 
 Previously when using the drawer navigator screens would unmount when inactive, and when you switch back to them you’d need to re-render the entire thing. In tabs these stay in memory as you would expect, so once you switch to the screen once it’s faster to go back there again and you don’t lose your place in a scroll view or anything. Drawer now behaves the same way, but you can go back to the old behavior if you like by passing in `unmountInactiveRoutes: true` in the drawer navigation configuration.
 
-# New features
+## New features
 
 - react-navigation now exports `ScrollView`, `FlatList`, and `SectionList` that will scroll to top when tapping on the active tab as you would expect from native tab bars.
 - Drawer supports two more types in addition to the default ‘front’ behavior that you expect from typical Android drawers: back and slide.
@@ -132,37 +130,35 @@ const Store = createStackNavigator({
 });
 ```
 
-
 - Basic support for hooks in `react-navigation-hooks`
 - `headerBackgroundTransitionPreset: 'toggle' | 'fade' | 'translate'` lets you choose how to transition your custom `headerBackground` components between screens.
 - 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`.
-- 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).
+- 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>).
 
-# Assorted fixes & improvements
+## Assorted fixes & improvements
 
 - 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.
-- 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
+- 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>
 - Support inverted gesture in modals.
 - 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).
-- 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).
-# Ecosystem and web support
+- 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>).
+
+## Ecosystem and web support
 
 React Navigation 3.0 brings some important changes to the React Navigation ecosystem: the project now lives across a number of repositories and packages, we have an exciting new transitioner on the way, and the core finally has first-class support for web apps on the client and server!
 
-## Independent Projects
+### Independent Projects
 
 React Navigation has always been a set of loosely-coupled navigation components: Stack, Tabs, Drawer, etc. But until now they have always lived in the main navigation repo, which has been difficult to maintain. People often struggle to use different versions of these components, or they want to fork them for their own app.
 
 In v3, all of our main packages and repos are separated. There are the following core packages in our new NPM org:
 
-
 - `@react-navigation/core` - The primitives and utilities that define our patterns, plus several routers
 - `@react-navigation/native` - Container and support for navigators on React Native apps. `createAppContainer` from the main `react-navigation` package actually comes from this package.
 - `@react-navigation/web` - Web browser app container, and utilities for server rendering
 
 In addition, we have published our community-maintained components as standalone repos and packages:
 
-
 - `react-navigation-stack`
 - `react-navigation-tabs`
 - `react-navigation-drawer`
@@ -171,14 +167,12 @@ In addition, we have published our community-maintained components as standalone
 
 To keep the experience as simple as possible the `react-navigation` package will continue to be supported, and will contain most of the above components as it did before.
 
-
-## Web Support
+### Web Support
 
 Now that the core of React Navigation can be used outside of React Native, we can provide first-class web support to anyone using React.js on the web, including those who do not want to use `react-native-web`.
 
 Here is an example web app which demonstrates the new `createBrowserApp` container and the built-in  `Link` component:
 
-
 ```js
 import { createSwitchNavigator } from "@react-navigation/core";
 import { createBrowserApp, Link } from "@react-navigation/web";
@@ -219,7 +213,6 @@ The above `Link` tag will render to:
 
 See a simple web app with Create React App [here](https://github.com/react-navigation/example-web). Or take a look at [this razzle app](https://github.com/react-navigation/web-server-example) for a more complicated example including server rendering.
 
-
 ----------
 
-Thanks for reading, please post any issues you encounter to https://github.com/react-navigation/react-navigation/issues!
+Thanks for reading, please post any issues you encounter to <https://github.com/react-navigation/react-navigation/issues>!