Merge branch 'master' of github.com:supabase/monorepo

This commit is contained in:
Copple committed 2020-01-03 10:12:42 +08:00
commit 36b18a7fda
10 files changed
+114 -42

No files matched your search

-6
View File
@@ -1,6 +0,0 @@
---
id: getting-started
title: Getting Started
---
@todo
+1 -1
View File
@@ -1,6 +1,6 @@
---
id: faq
title: FAQ's
title: FAQs
---
@todo
File renamed without changes.
+79
View File
@@ -0,0 +1,79 @@
---
id: getting-started
title: Getting Started
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Including Supabase
---
<Tabs
defaultValue="nodeJs"
values={[
{ label: 'Node.js', value: 'nodeJs', },
{ label: 'Python', value: 'py', },
]
}>
<TabItem value="nodeJs">
```js
import { Supabase } from "@supabase/supabase-js";
```
</TabItem>
<TabItem value="py">
```py
from supabase import Supabase
```
</TabItem>
</Tabs>
## Initializing
---
### Supabase(supabaseURL, supabaseKey, options?)
This is used to initialize an instance of a Supabase object. From here, you would be able
to access all of the features provided by Supabase.
### Examples
<Tabs
defaultValue="nodeJs"
values={[
{ label: 'Node.js', value: 'nodeJs', },
{ label: 'Python', value: 'py', },
]
}>
<TabItem value="nodeJs">
```js
const supabase = Supabase("https://supabase.io/xyzcompany", "1a2b-3c4d-5e6f-7g8h");
```
</TabItem>
<TabItem value="py">
```py
supabase = Supabase("https://supabase.io/xyzcompany", "1a2b-3c4d-5e6f-7g8h")
```
</TabItem>
</Tabs>
### Method arguments
#### supabaseURL
`required` string
Your unique Supabase URL.
#### supabaseKey
`required` string
Your unique Supabase Key.
#### options
`optional` object
| Parameter | Data Type | Description |
| ----------- | --------- | ----------- |
| @todo | | |
@@ -1,6 +1,6 @@
---
id: subscribe
title: "Subscribe to realtime changes"
title: "Subscribe to Realtime Changes"
---
Our library makes it simple to listen to changes in your database.
@@ -1,6 +1,6 @@
---
id: delete
title: 'Remove rows'
title: 'Remove Rows'
---
@todo short Description
@@ -1,6 +1,6 @@
---
id: get
title: 'Fetch your data'
title: 'Fetch Your Data'
---
@todo short Description
@@ -1,6 +1,6 @@
---
id: patch
title: 'Update rows'
title: 'Update Rows'
---
@todo short Description
@@ -1,6 +1,6 @@
---
id: post
title: 'Create new rows'
title: 'Create New Rows'
---
+29 -30
View File
@@ -6,34 +6,33 @@
*/
module.exports = {
docs: [
{
type: "category",
label: "Introduction",
items: [
"about",
"faq",
]
},
{
type: "category",
label: "API",
items: [
"api/getting-started",
"api/authentication",
"api/subscribe",
"api/get",
"api/post",
"api/patch",
"api/delete",
]
},
{
type: "category",
label: "Guides",
items: [
"guides/examples",
]
}
]
docs: {
Introduction:[
"about",
"faq"
],
Library:[
"library/getting-started",
{
type: "category",
label: "Realtime",
items: [
"library/realtime/subscribe"
]
},
{
type: "category",
label: "RESTful",
items: [
"library/restful/get",
"library/restful/post",
"library/restful/patch",
"library/restful/delete"
]
}
],
Guides:[
"guides/examples"
]
}
};