Skip to content

Commit d2db6ba

Browse files
author
Rishabh
committed
adds v2 docs - initial commit
1 parent 7ec38f5 commit d2db6ba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+21386
-0
lines changed

v2/.gitignore

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

v2/HOW_TO_NEW_DOCS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# To create a new doc project, you will need to:
2+
- Copy the `change_me` folder and rename it to the new docs
3+
- Copy `@docusaurus/plugin-content-docs` that belongs to `id: "change_me"`
4+
- Change `change_me` in that to the new docs project within that block
5+
- If this doc will have a version, copy `docsVersionDropdown` navbar item and change `change_me` in that.
6+
- If the github icon is not to be shown in the docs, modify `DO_NOT_SHOW_GITHUB_BUTTON` in `src/theme/NavbarItem/index.js`

v2/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Website
2+
3+
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4+
5+
## Installation
6+
7+
```console
8+
yarn install
9+
```
10+
11+
## Local Development
12+
13+
```console
14+
yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
## Build
20+
21+
```console
22+
yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
## Deployment
28+
29+
```console
30+
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
31+
```
32+
33+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

v2/android_versions.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[
2+
"1.1.0",
3+
"1.0.0"
4+
]

v2/babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Collapsible Element
6+
7+
You can expand / minimize content by using the below:
8+
9+
<details><summary style={{
10+
fontSize: "20px"
11+
}}>appName (compulsory)</summary>
12+
This is the name of your application. It is used when sending password reset or email verification emails (in the default email design). An example of this is appName: "GitHub".
13+
</details>
14+
15+
<br />
16+
17+
<details><summary style={{
18+
fontSize: "20px"
19+
}}>websiteDomain (compulsory)</summary>
20+
21+
This is the domain part of your website on which the SuperTokens' will operate on. By operate, we mean that the login UI will be shown on this domain and / or the session information will be stored under this domain. For example:
22+
23+
- For local development, you are likely using localhost with some port (ex 8080). Then the value of this should be `"http://localhost:8080"`.
24+
- If your website is `https://www.example.com`, then the value of this should be `"https://www.example.com"`.
25+
- If your website is `https://example.com`, then the value of this should be `"https://example.com"`.
26+
- If you have multiple sub domains, and your users login via `https://auth.example.com`, then the value of this should be `"https://auth.example.com"`.
27+
28+
By default, the login UI will be displayed on `{websiteDomain}/auth/*` (See about websiteBasePath to change the `/auth/*` part).
29+
30+
We need the domain information on the frontend for routing purposes, and on the backend so that we can generate correct email verification and password reset links.
31+
32+
</details>
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Deep info",
3+
"position": 4
4+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Deep info 1",
3+
"position": 1
4+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Deep info 2",
3+
"position": 1
4+
}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Deep info 3",
3+
"position": 1
4+
}

0 commit comments

Comments
 (0)