diff --git a/contributors.yml b/contributors.yml index 7e9d8a5445..a14da780ec 100644 --- a/contributors.yml +++ b/contributors.yml @@ -1,5 +1,6 @@ - abhi-kr-2100 - Ajayff4 +- avipatel97 - awreese - bhbs - BrianT1414 @@ -7,11 +8,13 @@ - brophdawg11 - chaance - chasinhues +- chensokheng - chrisngobanh - christopherchudzicki - cvbuelow - edwin177 - elylucas +- emzoumpo - gijo-varghese - hongji00 - hsbtr @@ -20,6 +23,7 @@ - Isammoc - JakubDrozd - janpaepke +- jimniels - jmargeta - jonkoops - kantuni @@ -40,16 +44,18 @@ - paulsmithkc - petersendidit - RobHannay -- ryanflorence - rtmann +- ryanflorence - sanketshah19 - sergiodxa - shamsup - shihanng - shivamsinghchahar +- theostavrides - thisiskartik - ThornWu - timdorr +- tkindy - turansky - underager - vijaypushkin diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index f7f12b13c2..0000000000 --- a/docs/api.md +++ /dev/null @@ -1,1488 +0,0 @@ ---- -title: API Reference -order: 2 ---- - -# API Reference - -React Router is a collection of [React components](https://reactjs.org/docs/components-and-props.html), [hooks](https://reactjs.org/docs/hooks-intro.html) and utilities that make it easy to build multi-page applications with [React](https://reactjs.org). This reference contains the function signatures and return types of the various interfaces in React Router. - -## Overview - -### Packages - -React Router is published to npm in three different packages: - -- [`react-router`](https://npm.im/react-router) contains most of the core functionality of React Router including the route matching algorithm and most of the core components and hooks -- [`react-router-dom`](https://npm.im/react-router-dom) includes everything from `react-router` and adds a few DOM-specific APIs, including [``](#browserrouter), [``](#hashrouter), and [``](#link) -- [`react-router-native`](https://npm.im/react-router-native) includes everything from `react-router` and adds a few APIs that are specific to React Native, including [``](#nativerouter) and [a native version of ``](#link-react-native) - -Both `react-router-dom` and `react-router-native` automatically include `react-router` as a dependency when you install them, and both packages re-export everything from `react-router`. **When you `import` stuff, you should always import from either `react-router-dom` or `react-router-native` and never directly from `react-router`**. Otherwise you may accidentally import mismatched versions of the library in your app. - -If you [installed](./getting-started/installation.md) React Router as a global (using a `