Starts the dart reference docs

This commit is contained in:
Paul Copplestone committed 2021-07-20 12:08:42 +08:00
1 parent 0662e2b052
commit 8edbfa37c9
4 files changed
+74

No files matched your search

+1
View File
@@ -8,6 +8,7 @@
"swizzle": "docusaurus swizzle",
"traction": "node traction.js",
"gen:all": "npm run gen:supabase && npm run gen:gotrue && npm run gen:postgrest && npm run gen:realtime && npm run gen:postgres && npm run gen:cli",
"gen:dart": "ts-node ReferenceGenerator.ts -o docs/reference/dart spec/dart.yml",
"gen:gotrue": "ts-node ReferenceGenerator.ts -o docs/gotrue/client spec/gotrue.yml",
"gen:postgrest": "ts-node ReferenceGenerator.ts -o docs/postgrest/client spec/postgrest.yml",
"gen:realtime": "ts-node ReferenceGenerator.ts -o docs/realtime/client spec/realtime.yml",
+10
View File
@@ -0,0 +1,10 @@
module.exports = {
docs: [
{
type: 'category',
label: 'About',
items: ['reference/dart/index', 'reference/dart/installing', 'reference/dart/initializing'],
collapsed: true,
}
],
}
+7
View File
@@ -5,6 +5,7 @@
* LICENSE file in the root directory of this source tree.
*/
const dartClient = require('./sidebar_spec_dart')
const goTrueClient = require('./sidebar_spec_gotrue')
const postgrestClient = require('./sidebar_spec_postgrest')
const realtimeClient = require('./sidebar_spec_realtime')
@@ -44,6 +45,12 @@ module.exports = {
collapsed: false,
items: supabaseClient.docs,
},
{
type: 'category',
label: 'Dart',
collapsed: false,
items: dartClient.docs,
},
{
type: 'category',
label: 'Postgres',
+56
View File
@@ -0,0 +1,56 @@
openref: 0.1
info:
id: reference/dart
title: Getting started
description: |
Supabase Dart.
definition: spec/combined.json
libraries:
- name: 'Dart'
id: 'dart'
version: '0.0.1'
docs:
path: reference/dart/
sidebar:
- name: 'About'
items:
- index
- Installing
- Initializing
pages:
Installing:
description: |
Dart libraries are built and suppported by the community.
```bash
# TODO
```
Find the source code on [GitHub](https://github.com/supabase/supabase-dart).
## Flutter
TODO: Some notes about flutter
Initializing:
description: |
You can initialize a new Supabase client using the `createClient()` method.
The Supabase client is your entrypoint to the rest of the Supabase functionality
and is the easiest way to interact with everything we offer within the Supabase ecosystem.
examples:
- name: example()
dart: |
```dart
TODO
```
- name: example()
dart: |
```dart
TODO
```