mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 18:35:07 +03:00
Copple
a788003648
## What kind of change does this PR introduce? Updates the docs with the new developer experience: https://deploy-preview-253--supabase.netlify.app/docs - Documents the new Auth using `gotrue-js` - Fixes #179 - Fixes OAuth links https://github.com/supabase/supabase/issues/241#issuecomment-705632335 - [x] Add docs on Policies ## Additional context Related PR on `supabase-js` https://github.com/supabase/supabase-js/pull/50 * Updates the docs for the new Auth DX. * docs: adds docs for subscribing to rows * Updates all the reads * Updates all the docs with the new format * docs: Replaces all { error, data} with data first, because I subjectively think it looks better * Adds some of the breaking changes to a blog post * Adds headings * removes the blog post since it is now in notion * Adds the Oauth changes * removes recharts because we no longer use it * Adds basic structure for GoTrue ref * Adds styles for the api reference docs * Adds more generated docs * Downloads the files to work locally * Adds a supabase generator * Moves some of the guides into the "tools" folder * Re-shuffles some of the pages around * Generated everythign related to the Supabase Client * Refactors and categorieses the pages * Changes the names to be more readable * Migrates almost all of the filters into the API reference * Moves most of the stored procedure filters * Adds realtime-js to the mix * More desciptive titles * Moves all the generated docs to the docs folder * Moves over some of the data manipulators * Extracts most of the client functionality to the API ref * Adds more detail to the guides * Removes the reference to the emulator * Adds the supabase 1.0 blog post * Adds a redirects for netlify * chore: Updates packages * Updates broken links * Adding docs for the server * Adds comments to gotrue and pgapi * Adds a twitter icon to our navbar * Updates the auth with the new user and session return values * Updates the sponsors * Styles for cards * Adds a default value to all of the Tabs
55 lines
1.1 KiB
TypeScript
55 lines
1.1 KiB
TypeScript
import { TsDoc } from '../definitions'
|
|
|
|
const fs = require('fs')
|
|
|
|
/**
|
|
* tsDocCommentToMdParams()
|
|
*/
|
|
export const tsDocCommentToMdParams = (tags?: TsDoc.CommentTag[]) =>
|
|
tags
|
|
.filter((x) => x.tag == 'param')
|
|
.map((x) =>
|
|
`
|
|
tag
|
|
|
|
`.trim()
|
|
)
|
|
.join('\n')
|
|
|
|
/**
|
|
* tsDocCommentToMarkdown()
|
|
*/
|
|
export const tsDocCommentToMdComment = (commentObject: TsDoc.DocComment) =>
|
|
`
|
|
${commentObject?.shortText || ''}
|
|
|
|
${commentObject?.text || ''}
|
|
|
|
`.trim()
|
|
|
|
/**
|
|
* slugify()
|
|
*/
|
|
export const slugify = (text) => {
|
|
return text
|
|
.toString()
|
|
.toLowerCase()
|
|
.replace(/[. )(]/g, '-') // Replace spaces and brackets -
|
|
.replace(/[^\w\-]+/g, '') // Remove all non-word chars
|
|
.replace(/\-\-+/g, '-') // Replace multiple - with single -
|
|
.replace(/^-+/, '') // Trim - from start of text
|
|
.replace(/-+$/, '') // Trim - from end of text
|
|
}
|
|
|
|
/**
|
|
* writeToDisk()
|
|
*/
|
|
export const writeToDisk = (fileName: string, content: any) => {
|
|
return new Promise((resolve, reject) => {
|
|
fs.writeFile(fileName, content, (err) => {
|
|
if (err) return reject(err)
|
|
else return resolve(true)
|
|
})
|
|
})
|
|
}
|