lywsvip/supabase
1
0
Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-05-30 17:32:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add storage config

Browse Source
This commit is contained in:
Terry Sutton
2022-11-24 15:00:44 -03:30
parent d26949eda6
commit 4dce2cd75e
6 changed files with 159 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
apps/docs/lib/refGenerator/refTypes.ts Normal file
View File

@@ -0,0 +1,17 @@
export type Link = {
name: string
link: string
}
export type Parameter = {
id: string
title: string
description: string
summary: string
tags?: string[]
links?: Link[]
subcommands?: []
usage?: string
required?: boolean
default?: boolean
}

68
apps/docs/pages/new/reference/auth/config.tsx Normal file
View File

@@ -0,0 +1,68 @@
// @ts-expect-error
import specFile from '~/../../spec/realtime_v0_config.yaml' assert { type: 'yml' }
import { Parameter } from '~/lib/refGenerator/refTypes'
import ReactMarkdown from 'react-markdown'
// Parameters are grouped on the page by tag
const TAGS = ['general', 'database']
export default function Config() {
return (
<div>
<div className="flex my-16">
<div className="w-full prose">
<h1 className="text-4xl mb-16">{specFile.info.title} Configuration</h1>
<ReactMarkdown>{specFile.info.description}</ReactMarkdown>
<div>
{TAGS.map((tag) =>
specFile.parameters
.filter((param: Parameter) => param.tags[0] === tag)
.map((parameter: Parameter, index) => (
<div>
{index === 0 && <h2 className="text-xl capitalize">{tag} Settings</h2>}
<div className="mt-8">
<div>
<h2 className="text-xl font-medium text-scale-1200 font-mono">
<span className="mr-2">$</span>
{parameter.title}
</h2>
<div className="grid" id={parameter.id}>
<div className="border-b pb-8" key={parameter.id}>
<div className=" mb-16">
<p className="mb-4 scroll-mt-16 mt-0 text-scale-1100 text-base">
<ReactMarkdown>{parameter.description}</ReactMarkdown>
</p>
<div className="grid gap-2">
<div className="flex gap-2">
Required: <code>{parameter.required.toString()}</code>
</div>
<div className="flex gap-2">
Default:
<code>
{parameter.default ? parameter.default.toString() : 'None'}
</code>
</div>
</div>
</div>
{parameter.links &&
parameter.links.map((link) => (
<div>
<h3>See also:</h3>
<li>
<a href={link.link}>{link.name}</a>
</li>
</div>
))}
</div>
</div>
</div>
</div>
</div>
))
)}
</div>
</div>
</div>
</div>
)
}

2
apps/docs/pages/new/reference/cli/[...slug].tsx
View File

@@ -32,7 +32,7 @@ export type Command = {
usage?: string
}
export default function CliUsage() {
export default function Config() {
return (
<RefSubLayout>
<div className="flex my-16">

22
apps/docs/pages/new/reference/cli/config.tsx
View File

@@ -1,30 +1,12 @@
// @ts-expect-error
import specFile from '~/../../spec/cli_v1_config.yaml' assert { type: 'yml' }
import { Parameter } from '~/lib/refGenerator/refTypes'
import ReactMarkdown from 'react-markdown'
export type Link = {
name: string
link: string
}
export type Parameter = {
id: string
title: string
description: string
summary: string
tags?: string[]
links?: Link[]
subcommands?: []
usage?: string
required?: boolean
default?: boolean
}
// Parameters are grouped on the page by tag
const TAGS = ['general', 'auth', 'api', 'database', 'dashboard', 'local']
export default function CliUsage() {
export default function Config() {
return (
<div>
<div className="flex my-16">

21
apps/docs/pages/new/reference/realtime/config.tsx
View File

@@ -1,30 +1,13 @@
// @ts-expect-error
import specFile from '~/../../spec/realtime_v0_config.yaml' assert { type: 'yml' }
import { Parameter } from '~/lib/refGenerator/refTypes'
import ReactMarkdown from 'react-markdown'
export type Link = {
name: string
link: string
}
export type Parameter = {
id: string
title: string
description: string
summary: string
tags?: string[]
links?: Link[]
subcommands?: []
usage?: string
required?: boolean
default?: boolean
}
// Parameters are grouped on the page by tag
const TAGS = ['general', 'database']
export default function CliUsage() {
export default function Config() {
return (
<div>
<div className="flex my-16">

69
apps/docs/pages/new/reference/storage/config.tsx Normal file
View File

@@ -0,0 +1,69 @@
// @ts-expect-error
import specFile from '~/../../spec/storage_v0_config.yaml' assert { type: 'yml' }
import { Parameter } from '~/lib/refGenerator/refTypes'
import ReactMarkdown from 'react-markdown'
// Parameters are grouped on the page by tag
const TAGS = ['general', 'multitenant']
console.log(specFile)
export default function Config() {
return (
<div>
<div className="flex my-16">
<div className="w-full prose">
<h1 className="text-4xl mb-16">{specFile.info.title} Configuration</h1>
<ReactMarkdown>{specFile.info.description}</ReactMarkdown>
<div>
{TAGS.map((tag) =>
specFile.parameters
.filter((param: Parameter) => param.tags[0] === tag)
.map((parameter: Parameter, index) => (
<div>
{index === 0 && <h2 className="text-xl capitalize">{tag} Settings</h2>}
<div className="mt-8">
<div>
<h2 className="text-xl font-medium text-scale-1200 font-mono">
<span className="mr-2">$</span>
{parameter.title}
</h2>
<div className="grid" id={parameter.id}>
<div className="border-b pb-8" key={parameter.id}>
<div className=" mb-16">
<p className="mb-4 scroll-mt-16 mt-0 text-scale-1100 text-base">
<ReactMarkdown>{parameter.description}</ReactMarkdown>
</p>
<div className="grid gap-2">
<div className="flex gap-2">
Required: <code>{parameter.required.toString()}</code>
</div>
<div className="flex gap-2">
Default:
<code>
{parameter.default ? parameter.default.toString() : 'None'}
</code>
</div>
</div>
</div>
{parameter.links &&
parameter.links.map((link) => (
<div>
<h3>See also:</h3>
<li>
<a href={link.link}>{link.name}</a>
</li>
</div>
))}
</div>
</div>
</div>
</div>
</div>
))
)}
</div>
</div>
</div>
</div>
)
}