fixes #232

supertokens · Feb 25, 2022 · 470132d · 470132d
1 parent a0c30fb
commit 470132d
Show file tree

Hide file tree

Showing 34 changed files with 120 additions and 31 deletions.
diff --git a/v2/auth-react/installation.mdx b/v2/auth-react/installation.mdx
@@ -4,12 +4,14 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 # ReactJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/auth-react_versioned_docs/version-0.15.X/installation.mdx b/v2/auth-react_versioned_docs/version-0.15.X/installation.mdx
@@ -4,12 +4,15 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
+
 # ReactJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/community/apis.mdx b/v2/community/apis.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/apis.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # API Reference
 
 :::important
 - This section is only for detailed API reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 

diff --git a/v2/community/sdks.mdx b/v2/community/sdks.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/sdks.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # SDK Reference
 
 :::important
 - This section is only for detailed SDK reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 ## Backend

diff --git a/v2/docusaurus.config.js b/v2/docusaurus.config.js
@@ -168,6 +168,16 @@ module.exports = {
         remarkPlugins: remarkPlugins,
       },
     ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'guides',
+        path: 'guides',
+        routeBasePath: 'docs/guides',
+        editUrl: 'https://github.com/supertokens/docs/tree/master/v2/',
+        remarkPlugins: remarkPlugins,
+      },
+    ],
     [
       '@docusaurus/plugin-content-docs',
       {

diff --git a/v2/emailpassword/apis.mdx b/v2/emailpassword/apis.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/apis.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # API Reference
 
 :::important
 - This section is only for detailed API reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 

diff --git a/v2/emailpassword/sdks.mdx b/v2/emailpassword/sdks.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/sdks.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # SDK Reference
 
 :::important
 - This section is only for detailed SDK reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 ## Backend

diff --git a/v2/guides/guides.mdx b/v2/guides/guides.mdx
@@ -0,0 +1,14 @@
+---
+id: guides
+title: Recipe guides
+hide_title: true
+slug: /
+---
+
+# Recipe guides below
+
+- [EmailPassword](/docs/emailpassword/introduction)
+- [ThirdParty](/docs/thirdparty/introduction)
+- [ThirdPartyEmailPassword](/docs/thirdpartyemailpassword/introduction)
+- [Passwordless](/docs/passwordless/introduction)
+- [Session](/docs/session/introduction)
diff --git a/v2/nodejs/init.mdx b/v2/nodejs/init.mdx
@@ -4,6 +4,8 @@ title: init
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 ## `Supertokens.init(config)`
 
 In your `index.js`, you need to call the `Supertokens.init` function to initialise SuperTokens. You can provide it the following config:
@@ -53,4 +55,4 @@ Supertokens.init({
 - Pass `true` if you are using this library in a serverless environment as it will help to optimise the performance.
 - Default: `false`
 ### ``recipeList``
-- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this [link](https://supertokens.com/docs/guides) or the other sections in this docs.
+- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this <GuidesLink>link</GuidesLink>) or the other sections in this docs.
diff --git a/v2/nodejs/installation.mdx b/v2/nodejs/installation.mdx
@@ -4,12 +4,14 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 # NodeJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/nodejs_versioned_docs/version-6.0.X/init.mdx b/v2/nodejs_versioned_docs/version-6.0.X/init.mdx
@@ -4,6 +4,8 @@ title: Supertokens Init
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 ## `Supertokens.init(config)`
 
 In your `index.js`, you need to call the `Supertokens.init` function to initialise SuperTokens. You can provide it the following config:
@@ -43,4 +45,4 @@ Supertokens.init({
 - Pass `true` if you are using this library in a serverless environment as it will help to optimise the performance.
 - Default: `false`
 ### ``recipeList``
-- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this [link](https://supertokens.com/docs/guides) or the other sections in this docs.
+- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this <GuidesLink>link</GuidesLink>) or the other sections in this docs.
diff --git a/v2/nodejs_versioned_docs/version-6.0.X/installation.mdx b/v2/nodejs_versioned_docs/version-6.0.X/installation.mdx
@@ -4,12 +4,14 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 # NodeJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/nodejs_versioned_docs/version-6.1.X/init.mdx b/v2/nodejs_versioned_docs/version-6.1.X/init.mdx
@@ -4,6 +4,8 @@ title: init
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 ## `Supertokens.init(config)`
 
 In your `index.js`, you need to call the `Supertokens.init` function to initialise SuperTokens. You can provide it the following config:
@@ -43,4 +45,4 @@ Supertokens.init({
 - Pass `true` if you are using this library in a serverless environment as it will help to optimise the performance.
 - Default: `false`
 ### ``recipeList``
-- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this [link](https://supertokens.com/docs/guides) or the other sections in this docs.
+- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this <GuidesLink>link</GuidesLink>) or the other sections in this docs.
diff --git a/v2/nodejs_versioned_docs/version-6.1.X/installation.mdx b/v2/nodejs_versioned_docs/version-6.1.X/installation.mdx
@@ -4,12 +4,14 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 # NodeJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/nodejs_versioned_docs/version-7.0.X/init.mdx b/v2/nodejs_versioned_docs/version-7.0.X/init.mdx
@@ -4,6 +4,8 @@ title: init
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 ## `Supertokens.init(config)`
 
 In your `index.js`, you need to call the `Supertokens.init` function to initialise SuperTokens. You can provide it the following config:
@@ -53,4 +55,4 @@ Supertokens.init({
 - Pass `true` if you are using this library in a serverless environment as it will help to optimise the performance.
 - Default: `false`
 ### ``recipeList``
-- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this [link](https://supertokens.com/docs/guides) or the other sections in this docs.
+- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this <GuidesLink>link</GuidesLink>) or the other sections in this docs.
diff --git a/v2/nodejs_versioned_docs/version-7.0.X/installation.mdx b/v2/nodejs_versioned_docs/version-7.0.X/installation.mdx
@@ -4,12 +4,14 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 # NodeJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/nodejs_versioned_docs/version-7.1.X/init.mdx b/v2/nodejs_versioned_docs/version-7.1.X/init.mdx
@@ -4,6 +4,8 @@ title: init
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 ## `Supertokens.init(config)`
 
 In your `index.js`, you need to call the `Supertokens.init` function to initialise SuperTokens. You can provide it the following config:
@@ -53,4 +55,4 @@ Supertokens.init({
 - Pass `true` if you are using this library in a serverless environment as it will help to optimise the performance.
 - Default: `false`
 ### ``recipeList``
-- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this [link](https://supertokens.com/docs/guides) or the other sections in this docs.
+- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this <GuidesLink>link</GuidesLink>) or the other sections in this docs.
diff --git a/v2/nodejs_versioned_docs/version-7.1.X/installation.mdx b/v2/nodejs_versioned_docs/version-7.1.X/installation.mdx
@@ -4,12 +4,14 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 # NodeJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/nodejs_versioned_docs/version-7.2.X/init.mdx b/v2/nodejs_versioned_docs/version-7.2.X/init.mdx
@@ -4,6 +4,8 @@ title: init
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 ## `Supertokens.init(config)`
 
 In your `index.js`, you need to call the `Supertokens.init` function to initialise SuperTokens. You can provide it the following config:
@@ -53,4 +55,4 @@ Supertokens.init({
 - Pass `true` if you are using this library in a serverless environment as it will help to optimise the performance.
 - Default: `false`
 ### ``recipeList``
-- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this [link](https://supertokens.com/docs/guides) or the other sections in this docs.
+- List of Recipes you want to use. You need to pass atleast one Recipe to ths array. For more info on Recipes, checkout this <GuidesLink>link</GuidesLink>) or the other sections in this docs.
diff --git a/v2/nodejs_versioned_docs/version-7.2.X/installation.mdx b/v2/nodejs_versioned_docs/version-7.2.X/installation.mdx
@@ -4,12 +4,14 @@ title: Installation
 hide_title: true
 ---
 
+import GuidesLink from "/src/components/guidesLink"
+
 # NodeJS SDK
 
 :::important
 This documentation is only for reference, and not a step by step guide for how to implement SuperTokens.
 
-For a guide, please see the [Getting started section](https://supertokens.com/docs/guides).
+For a guide, please see the <GuidesLink>Getting started section</GuidesLink>.
 :::
 
 ## Installation

diff --git a/v2/passwordless/apis.mdx b/v2/passwordless/apis.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/apis.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # API Reference
 
 :::important
 - This section is only for detailed API reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 

diff --git a/v2/passwordless/sdks.mdx b/v2/passwordless/sdks.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/sdks.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # SDK Reference
 
 :::important
 - This section is only for detailed SDK reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 ## Backend

diff --git a/v2/session/apis.mdx b/v2/session/apis.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/apis.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # API Reference
 
 :::important
 - This section is only for detailed API reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 

diff --git a/v2/session/sdks.mdx b/v2/session/sdks.mdx
@@ -7,11 +7,13 @@ hide_title: true
 <!-- COPY DOCS -->
 <!-- ./community/sdks.mdx -->
 
+import GuidesLink from "/src/components/guidesLink"
+
 # SDK Reference
 
 :::important
 - This section is only for detailed SDK reference. This section will NOT provide a step by step guide.
-- For a step by step guide to implementing SuperTokens, please [pick a recipe](https://supertokens.com/docs/guides) and follow the setup instructions in there.
+- For a step by step guide to implementing SuperTokens, please <GuidesLink>pick a recipe</GuidesLink> and follow the setup instructions in there.
 :::
 
 ## Backend

diff --git a/v2/src/components/guidesLink.tsx b/v2/src/components/guidesLink.tsx
@@ -0,0 +1,5 @@
+import * as React from "react";
+
+export default function GuidesLink(props: any) {
+    return <a href="/docs/guides">{props.children}</a>;
+}
diff --git a/v2/src/pages/index.js b/v2/src/pages/index.js
@@ -12,7 +12,7 @@ function Hello() {
                     fontSize: '20px',
                 }}>
                 <p>
-                    <a href="/docs/community/introduction">Click here</a> to see the user docs
+                    <a href="/docs/guides">Click here</a> to see the user docs
                 </p>
             </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,7 +12,7 @@ function Hello() { @@
                         fontSize: '20px',
                     }}>
                     <p>
-                        <a href="/docs/community/introduction">Click here</a> to see the user docs
+                        <a href="/docs/guides">Click here</a> to see the user docs
                     </p>
                 </div>
@@ Expand Down @@