From 16f10dd32a2d293fd204180736e52917aaec08b9 Mon Sep 17 00:00:00 2001
From: Endi <endiliey@gmail.com>
Date: Wed, 30 Oct 2019 10:19:30 +0700
Subject: [PATCH] docs(v2): Redirect component for easy redirect (#1913)

* docs(v2): Redirect component for easy redirect

* typo

* docs

* Update website/docs/docusaurus-core.md

Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>

* Update docusaurus-core.md
---
 CHANGELOG-2.x.md                | 10 ++++++++++
 website/docs/docusaurus-core.md | 18 +++++++++++++++++-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG-2.x.md b/CHANGELOG-2.x.md
index f22b0c2ed9..a7d66ff9d7 100644
--- a/CHANGELOG-2.x.md
+++ b/CHANGELOG-2.x.md
@@ -9,6 +9,16 @@ If you've swizzled Algolia `SearchBar` component before, please update your sour
 + <div className="navbar__search" key="search-box">
 ```
 - Reduce memory usage consumption.
+- Add `<Redirect>` component for easy client side redirect.
+Example Uaage:
+```js
+import React from 'react';
+import {Redirect} from '@docusaurus/router';
+
+function Home() {
+  return <Redirect to="/docs/test" />;
+}
+```
 - Slightly adjust search icon position to be more aligned on small width device.
 - Convert sitemap plugin to TypeScript.
 - Significantly reduce main bundle size and initial HTML payload on production build. Generated JS files from webpack is also shorter in name.
diff --git a/website/docs/docusaurus-core.md b/website/docs/docusaurus-core.md
index dcb919eef8..b0118b3ec1 100644
--- a/website/docs/docusaurus-core.md
+++ b/website/docs/docusaurus-core.md
@@ -1,6 +1,7 @@
 ---
 id: docusaurus-core
-title: Docusaurus Core API
+title: Docusaurus Client API
+sidebar_title: Client API
 ---
 
 Docusaurus provides some API on client that can be helpful when building your site.
@@ -143,3 +144,18 @@ function Help() {
   );
 }
 ```
+
+## `<Redirect />`
+
+Rendering a `<Redirect>` will navigate to a new location. The new location will override the current location in the history stack, like server-side redirects (HTTP 3xx) do. You can refer to [React Router's Redirect documentation](https://reacttraining.com/react-router/web/api/Redirect) for more info on available props.
+
+Example usage:
+
+```jsx {2,5}
+import React from 'react';
+import {Redirect} from '@docusaurus/router';
+
+function Home() {
+  return <Redirect to="/docs/test" />;
+}
+```