- Supabase Docs
-
-
+ {children}
)
}
diff --git a/apps/docs/layouts/guides/index.tsx b/apps/docs/layouts/guides/index.tsx
index 105e250dd5b..34768852a2e 100644
--- a/apps/docs/layouts/guides/index.tsx
+++ b/apps/docs/layouts/guides/index.tsx
@@ -10,8 +10,10 @@ import components from '~/components'
import { highlightSelectedTocItem } from '~/components/CustomHTMLElements/CustomHTMLElements.utils'
import { FooterHelpCalloutType } from '~/components/FooterHelpCallout'
import GuidesTableOfContents from '~/components/GuidesTableOfContents'
+import { type MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import useHash from '~/hooks/useHash'
import { LayoutMainContent } from '../DefaultLayout'
+import { MainSkeleton } from '../MainSkeleton'
interface Props {
meta: {
@@ -30,6 +32,7 @@ interface Props {
toc?: any
currentPage?: string
hideToc?: boolean
+ menuId: MenuId
}
const Layout: FC = (props) => {
@@ -42,6 +45,8 @@ const Layout: FC = (props) => {
const { asPath } = useRouter()
const router = useRouter()
+ const menuId = props.menuId
+
const EDIT_BUTTON_EXCLUDE_LIST = ['/404']
useEffect(() => {
@@ -108,77 +113,79 @@ const Layout: FC = (props) => {
},
}}
/>
-
-
- {props.children}
+
+
+
+
- {hasTableOfContents && !props.meta?.hide_table_of_contents && (
-
+
-
+ {props.children}
+
-
- )}
-
-
+ {hasTableOfContents && !props.meta?.hide_table_of_contents && (
+
+
+ )}
+
+
+
)
}
diff --git a/apps/docs/layouts/MainSkeleton.tsx b/apps/docs/layouts/MainSkeleton.tsx
new file mode 100644
index 00000000000..bf2b77aef4d
--- /dev/null
+++ b/apps/docs/layouts/MainSkeleton.tsx
@@ -0,0 +1,376 @@
+import { useTheme } from 'next-themes'
+import Image from 'next/legacy/image'
+import Link from 'next/link'
+import NavigationMenu, { type MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
+import TopNavBar from '~/components/Navigation/NavigationMenu/TopNavBar'
+
+import { PropsWithChildren, memo, useEffect } from 'react'
+import Footer from '~/components/Navigation/Footer'
+import { menuState, useMenuMobileOpen } from '~/hooks/useMenuState'
+
+const levelsData = {
+ home: {
+ icon: '/docs/img/icons/menu/home',
+ name: 'Home',
+ },
+ gettingstarted: {
+ icon: '/docs/img/icons/menu/getting-started',
+ name: 'Getting Started',
+ },
+ database: {
+ icon: '/docs/img/icons/menu/database',
+ name: 'Database',
+ },
+ api: {
+ icon: '/docs/img/icons/menu/rest',
+ name: 'REST API',
+ },
+ graphql: {
+ icon: '/docs/img/icons/menu/graphql',
+ name: 'GraphQL',
+ },
+ auth: {
+ icon: '/docs/img/icons/menu/auth',
+ name: 'Auth',
+ },
+ functions: {
+ icon: '/docs/img/icons/menu/functions',
+ name: 'Edge Functions',
+ },
+ realtime: {
+ icon: '/docs/img/icons/menu/realtime',
+ name: 'Realtime',
+ },
+ analytics: {
+ icon: '/docs/img/icons/menu/analytics',
+ name: 'Analytics',
+ },
+ storage: {
+ icon: '/docs/img/icons/menu/storage',
+ name: 'Storage',
+ },
+ ai: {
+ icon: '/docs/img/icons/menu/ai',
+ name: 'AI & Vectors',
+ },
+ supabase_cli: {
+ icon: '/docs/img/icons/menu/reference-cli',
+ name: 'Supabase CLI',
+ },
+ platform: {
+ icon: '/docs/img/icons/menu/platform',
+ name: 'Platform',
+ },
+ resources: {
+ icon: '/docs/img/icons/menu/resources',
+ name: 'Resources',
+ },
+ self_hosting: {
+ icon: '/docs/img/icons/menu/self-hosting',
+ name: 'Self-Hosting',
+ },
+ integrations: {
+ icon: '/docs/img/icons/menu/integrations',
+ name: 'Integrations',
+ },
+ reference_javascript_v1: {
+ icon: '/docs/img/icons/menu/reference-javascript',
+ name: 'Javascript Reference v1.0',
+ },
+ reference_javascript_v2: {
+ icon: '/docs/img/icons/menu/reference-javascript',
+ name: 'Javascript Reference v2.0',
+ },
+ reference_dart_v1: {
+ icon: '/docs/img/icons/menu/reference-dart',
+ name: 'Dart Reference v1.0',
+ },
+ reference_dart_v2: {
+ icon: '/docs/img/icons/menu/reference-dart',
+ name: 'Dart Reference v2.0',
+ },
+ reference_csharp_v0: {
+ icon: '/docs/img/icons/menu/reference-csharp',
+ name: 'C# Reference v0.0',
+ },
+ reference_python_v2: {
+ icon: '/docs/img/icons/menu/reference-python',
+ name: 'Python Reference v2.0',
+ },
+ reference_swift_v1: {
+ icon: '/docs/img/icons/menu/reference-swift',
+ name: 'Swift Reference v1.0',
+ },
+ reference_swift_v2: {
+ icon: '/docs/img/icons/menu/reference-swift',
+ name: 'Swift Reference v2.0',
+ },
+ reference_kotlin_v1: {
+ icon: '/docs/img/icons/menu/reference-kotlin',
+ name: 'Kotlin Reference v1.0',
+ },
+ reference_kotlin_v2: {
+ icon: '/docs/img/icons/menu/reference-kotlin',
+ name: 'Kotlin Reference v2.0',
+ },
+ reference_cli: {
+ icon: '/docs/img/icons/menu/reference-cli',
+ name: 'CLI Reference',
+ },
+ reference_api: {
+ icon: '/docs/img/icons/menu/reference-api',
+ name: 'Management API Reference',
+ },
+ reference_self_hosting_auth: {
+ icon: '/docs/img/icons/menu/reference-auth',
+ name: 'Auth Server Reference',
+ },
+ reference_self_hosting_storage: {
+ icon: '/docs/img/icons/menu/reference-storage',
+ name: 'Storage Server Reference',
+ },
+ reference_self_hosting_realtime: {
+ icon: '/docs/img/icons/menu/reference-realtime',
+ name: 'Realtime Server Reference',
+ },
+ reference_self_hosting_analytics: {
+ icon: '/docs/img/icons/menu/reference-analytics',
+ name: 'Analytics Server Reference',
+ },
+ reference_self_hosting_functions: {
+ icon: '/docs/img/icons/menu/reference-functions',
+ name: 'Functions Server Reference',
+ },
+}
+
+const MobileHeader = memo(function MobileHeader({ menuId }: { menuId: MenuId }) {
+ const mobileMenuOpen = useMenuMobileOpen()
+ const menuLevel = menuId
+
+ return (
+
+
+
+ )
+})
+
+const MobileMenuBackdrop = memo(function MobileMenuBackdrop() {
+ const mobileMenuOpen = useMenuMobileOpen()
+
+ useEffect(() => {
+ window.addEventListener('resize', (e: UIEvent) => {
+ const w = e.target as Window
+ if (mobileMenuOpen && w.innerWidth >= 1024) {
+ menuState.setMenuMobileOpen(!mobileMenuOpen)
+ }
+ })
+ return () => {
+ window.removeEventListener('resize', () => {})
+ }
+ }, [mobileMenuOpen])
+
+ return (
+
+ 
+
+
+ {mobileMenuOpen
+ ? 'Close'
+ : menuLevel
+ ? levelsData[menuLevel].name
+ : levelsData['home'].name}
+
+ menuState.setMenuMobileOpen(!mobileMenuOpen)}
+ >
+ )
+})
+
+const HeaderLogo = memo(function HeaderLogo() {
+ const { resolvedTheme } = useTheme()
+ return (
+
+
+
+ )
+})
+
+const NavContainer = memo(function NavContainer({ menuId }: { menuId: MenuId }) {
+ const mobileMenuOpen = useMenuMobileOpen()
+
+ return (
+
+ )
+})
+
+function MainSkeleton({ children, menuId }: PropsWithChildren<{ menuId: MenuId }>) {
+ return (
+ {props.children}
+
+
+
+
+ )
+}
+
+export { MainSkeleton }
diff --git a/apps/docs/layouts/SiteLayout.tsx b/apps/docs/layouts/SiteLayout.tsx
index ed1447aa80c..5754ddff924 100644
--- a/apps/docs/layouts/SiteLayout.tsx
+++ b/apps/docs/layouts/SiteLayout.tsx
@@ -1,349 +1,5 @@
-import { useTheme } from 'next-themes'
-import Image from 'next/legacy/image'
-import Link from 'next/link'
-import NavigationMenu from '~/components/Navigation/NavigationMenu/NavigationMenu'
-import TopNavBar from '~/components/Navigation/NavigationMenu/TopNavBar'
-
import Head from 'next/head'
-import { PropsWithChildren, memo, useEffect } from 'react'
-import Footer from '~/components/Navigation/Footer'
-import { menuState, useMenuLevelId, useMenuMobileOpen } from '~/hooks/useMenuState'
-
-const levelsData = {
- home: {
- icon: '/docs/img/icons/menu/home',
- name: 'Home',
- },
- gettingstarted: {
- icon: '/docs/img/icons/menu/getting-started',
- name: 'Getting Started',
- },
- database: {
- icon: '/docs/img/icons/menu/database',
- name: 'Database',
- },
- api: {
- icon: '/docs/img/icons/menu/rest',
- name: 'REST API',
- },
- graphql: {
- icon: '/docs/img/icons/menu/graphql',
- name: 'GraphQL',
- },
- auth: {
- icon: '/docs/img/icons/menu/auth',
- name: 'Auth',
- },
- functions: {
- icon: '/docs/img/icons/menu/functions',
- name: 'Edge Functions',
- },
- realtime: {
- icon: '/docs/img/icons/menu/realtime',
- name: 'Realtime',
- },
- analytics: {
- icon: '/docs/img/icons/menu/analytics',
- name: 'Analytics',
- },
- storage: {
- icon: '/docs/img/icons/menu/storage',
- name: 'Storage',
- },
- ai: {
- icon: '/docs/img/icons/menu/ai',
- name: 'AI & Vectors',
- },
- supabase_cli: {
- icon: '/docs/img/icons/menu/reference-cli',
- name: 'Supabase CLI',
- },
- platform: {
- icon: '/docs/img/icons/menu/platform',
- name: 'Platform',
- },
- resources: {
- icon: '/docs/img/icons/menu/resources',
- name: 'Resources',
- },
- self_hosting: {
- icon: '/docs/img/icons/menu/self-hosting',
- name: 'Self-Hosting',
- },
- integrations: {
- icon: '/docs/img/icons/menu/integrations',
- name: 'Integrations',
- },
- reference_javascript_v1: {
- icon: '/docs/img/icons/menu/reference-javascript',
- name: 'Javascript Reference v1.0',
- },
- reference_javascript_v2: {
- icon: '/docs/img/icons/menu/reference-javascript',
- name: 'Javascript Reference v2.0',
- },
- reference_dart_v1: {
- icon: '/docs/img/icons/menu/reference-dart',
- name: 'Dart Reference v1.0',
- },
- reference_dart_v2: {
- icon: '/docs/img/icons/menu/reference-dart',
- name: 'Dart Reference v2.0',
- },
- reference_csharp_v0: {
- icon: '/docs/img/icons/menu/reference-csharp',
- name: 'C# Reference v0.0',
- },
- reference_python_v2: {
- icon: '/docs/img/icons/menu/reference-python',
- name: 'Python Reference v2.0',
- },
- reference_swift_v1: {
- icon: '/docs/img/icons/menu/reference-swift',
- name: 'Swift Reference v1.0',
- },
- reference_swift_v2: {
- icon: '/docs/img/icons/menu/reference-swift',
- name: 'Swift Reference v2.0',
- },
- reference_kotlin_v1: {
- icon: '/docs/img/icons/menu/reference-kotlin',
- name: 'Kotlin Reference v1.0',
- },
- reference_kotlin_v2: {
- icon: '/docs/img/icons/menu/reference-kotlin',
- name: 'Kotlin Reference v2.0',
- },
- reference_cli: {
- icon: '/docs/img/icons/menu/reference-cli',
- name: 'CLI Reference',
- },
- reference_api: {
- icon: '/docs/img/icons/menu/reference-api',
- name: 'Management API Reference',
- },
- reference_self_hosting_auth: {
- icon: '/docs/img/icons/menu/reference-auth',
- name: 'Auth Server Reference',
- },
- reference_self_hosting_storage: {
- icon: '/docs/img/icons/menu/reference-storage',
- name: 'Storage Server Reference',
- },
- reference_self_hosting_realtime: {
- icon: '/docs/img/icons/menu/reference-realtime',
- name: 'Realtime Server Reference',
- },
- reference_self_hosting_analytics: {
- icon: '/docs/img/icons/menu/reference-analytics',
- name: 'Analytics Server Reference',
- },
- reference_self_hosting_functions: {
- icon: '/docs/img/icons/menu/reference-functions',
- name: 'Functions Server Reference',
- },
-}
-
-const MobileHeader = memo(function MobileHeader() {
- const mobileMenuOpen = useMenuMobileOpen()
- const menuLevel = useMenuLevelId()
-
- return (
-
+
+
+
+
+
+
+ {children}
+
+
+
-
-
- )
-})
-
-const MobileMenuBackdrop = memo(function MobileMenuBackdrop() {
- const mobileMenuOpen = useMenuMobileOpen()
-
- useEffect(() => {
- window.addEventListener('resize', (e: UIEvent) => {
- const w = e.target as Window
- if (mobileMenuOpen && w.innerWidth >= 1024) {
- menuState.setMenuMobileOpen(!mobileMenuOpen)
- }
- })
- return () => {
- window.removeEventListener('resize', () => {})
- }
- }, [mobileMenuOpen])
-
- return (
-
-
-
-
- {mobileMenuOpen
- ? 'Close'
- : menuLevel
- ? levelsData[menuLevel].name
- : levelsData['home'].name}
-
- menuState.setMenuMobileOpen(!mobileMenuOpen)}
- >
- )
-})
-
-const HeaderLogo = memo(function HeaderLogo() {
- const { resolvedTheme } = useTheme()
- return (
-
-
-
- )
-})
-
-const NavContainer = memo(function NavContainer() {
- const mobileMenuOpen = useMenuMobileOpen()
-
- return (
-
- )
-})
+import { PropsWithChildren } from 'react'
const SiteLayout = ({ children }: PropsWithChildren<{}>) => {
return (
@@ -351,32 +7,7 @@ const SiteLayout = ({ children }: PropsWithChildren<{}>) => {
{props.children}
-
-
-
-
-
-
-
-
-
-
-
- {children}
-
-
-
-
+
+
+
+
)
}
diff --git a/apps/docs/pages/guides/ai/[[...slug]].tsx b/apps/docs/pages/guides/ai/[[...slug]].tsx
index af8cc713906..a19f8a02e54 100644
--- a/apps/docs/pages/guides/ai/[[...slug]].tsx
+++ b/apps/docs/pages/guides/ai/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function AiGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/ai/python/[slug].tsx b/apps/docs/pages/guides/ai/python/[slug].tsx
index fcbd53160c0..952e4bfa099 100644
--- a/apps/docs/pages/guides/ai/python/[slug].tsx
+++ b/apps/docs/pages/guides/ai/python/[slug].tsx
@@ -11,6 +11,7 @@ import Layout from '~/layouts/DefaultGuideLayout'
import { UrlTransformFunction, linkTransform } from '~/lib/mdx/plugins/rehypeLinkTransform'
import remarkMkDocsAdmonition from '~/lib/mdx/plugins/remarkAdmonition'
import { removeTitle } from '~/lib/mdx/plugins/remarkRemoveTitle'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
// We fetch these docs at build time from an external repo
const org = 'supabase'
@@ -61,7 +62,7 @@ interface PythonClientDocsProps {
export default function PythonClientDocs({ source, meta }: PythonClientDocsProps) {
return (
-
+
)
diff --git a/apps/docs/pages/guides/api/[[...slug]].tsx b/apps/docs/pages/guides/api/[[...slug]].tsx
index 94951837d6d..d46e03fd7cc 100644
--- a/apps/docs/pages/guides/api/[[...slug]].tsx
+++ b/apps/docs/pages/guides/api/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function ApiGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/auth/[[...slug]].tsx b/apps/docs/pages/guides/auth/[[...slug]].tsx
index 777f65e6ddd..9e645a917ea 100644
--- a/apps/docs/pages/guides/auth/[[...slug]].tsx
+++ b/apps/docs/pages/guides/auth/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function AuthGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/cli/[[...slug]].tsx b/apps/docs/pages/guides/cli/[[...slug]].tsx
index 3e690745906..2dd168f672d 100644
--- a/apps/docs/pages/guides/cli/[[...slug]].tsx
+++ b/apps/docs/pages/guides/cli/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function CliGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/cli/config.tsx b/apps/docs/pages/guides/cli/config.tsx
index 3830af444f1..193f25fca66 100644
--- a/apps/docs/pages/guides/cli/config.tsx
+++ b/apps/docs/pages/guides/cli/config.tsx
@@ -5,6 +5,8 @@ import GuidesTableOfContents from '~/components/GuidesTableOfContents'
import { Heading } from '~/components/CustomHTMLElements'
import Head from 'next/head'
import { CodeBlock } from 'ui'
+import { MainSkeleton } from '~/layouts/MainSkeleton'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
// Parameters are grouped on the page by tag
const tocList = []
@@ -29,24 +31,26 @@ export default function Config() {
Supabase CLI config
-
- {props.meta?.breadcrumb && (
-
- {props.children}
-
- {EDIT_BUTTON_EXCLUDE_LIST.includes(router.route) ? (
- <>
- ) : (
-
-
- {!props.hideToc && hasTableOfContents && !props.meta?.hide_table_of_contents && (
+ {props.meta.breadcrumb}
- )} -{props.meta.title}
- {props.meta?.subtitle && ( -{props.meta.subtitle}
- )} - -
-
-
- )}
-
-
-
+ {!props.hideToc && hasTableOfContents && !props.meta?.hide_table_of_contents && (
+
- {props.meta?.tocVideo && !!tocVideoPreview && (
-
- )}
-
-
+ {props.children}
+
+ {EDIT_BUTTON_EXCLUDE_LIST.includes(router.route) ? (
+ <>
+ ) : (
+
)}
-
- On this page
-
-
+
{props.meta.breadcrumb}
+ )} +{props.meta.title}
+ {props.meta?.subtitle && ( +{props.meta.subtitle}
+ )} + +
+
+ )}
+
+ {props.meta?.tocVideo && !!tocVideoPreview && (
+
+
+
+ )}
+
+ On this page
+
+
-
-
+
)
diff --git a/apps/docs/pages/guides/database/[[...slug]].tsx b/apps/docs/pages/guides/database/[[...slug]].tsx
index fc7519ad2ba..0ee6416477b 100644
--- a/apps/docs/pages/guides/database/[[...slug]].tsx
+++ b/apps/docs/pages/guides/database/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -31,7 +32,7 @@ export default function DatabaseGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/database/extensions/wrappers/[[...slug]].tsx b/apps/docs/pages/guides/database/extensions/wrappers/[[...slug]].tsx
index 564d96d51d2..0d34ede0dcb 100644
--- a/apps/docs/pages/guides/database/extensions/wrappers/[[...slug]].tsx
+++ b/apps/docs/pages/guides/database/extensions/wrappers/[[...slug]].tsx
@@ -10,6 +10,7 @@ import remarkGfm from 'remark-gfm'
import codeHikeTheme from 'config/code-hike.theme.json' assert { type: 'json' }
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
import { UrlTransformFunction, linkTransform } from '~/lib/mdx/plugins/rehypeLinkTransform'
@@ -83,7 +84,7 @@ export default function WrappersDocs({
editLink,
}: InferGetStaticPropsType) {
return (
-
+
)
diff --git a/apps/docs/pages/guides/functions/[[...slug]].tsx b/apps/docs/pages/guides/functions/[[...slug]].tsx
index 8e41b131d3e..8a8ed0defd2 100644
--- a/apps/docs/pages/guides/functions/[[...slug]].tsx
+++ b/apps/docs/pages/guides/functions/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function FunctionsGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/getting-started/[[...slug]].tsx b/apps/docs/pages/guides/getting-started/[[...slug]].tsx
index 8791fae3a10..e16c15ac68f 100644
--- a/apps/docs/pages/guides/getting-started/[[...slug]].tsx
+++ b/apps/docs/pages/guides/getting-started/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function GettingStartedGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/graphql/[[...slug]].tsx b/apps/docs/pages/guides/graphql/[[...slug]].tsx
index 559e10f592b..00eaecfe221 100644
--- a/apps/docs/pages/guides/graphql/[[...slug]].tsx
+++ b/apps/docs/pages/guides/graphql/[[...slug]].tsx
@@ -5,14 +5,17 @@ import { serialize } from 'next-mdx-remote/serialize'
import { isAbsolute, relative } from 'path'
import rehypeSlug from 'rehype-slug'
import remarkGfm from 'remark-gfm'
-import codeHikeTheme from 'config/code-hike.theme.json' assert { type: 'json' }
+
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { UrlTransformFunction, linkTransform } from '~/lib/mdx/plugins/rehypeLinkTransform'
import remarkMkDocsAdmonition from '~/lib/mdx/plugins/remarkAdmonition'
import { removeTitle } from '~/lib/mdx/plugins/remarkRemoveTitle'
import remarkPyMdownTabs from '~/lib/mdx/plugins/remarkTabs'
+import codeHikeTheme from 'config/code-hike.theme.json' assert { type: 'json' }
+
// We fetch these docs at build time from an external repo
const org = 'supabase'
const repo = 'pg_graphql'
@@ -114,7 +117,7 @@ interface PGGraphQLDocsProps {
export default function PGGraphQLDocs({ source, meta }: PGGraphQLDocsProps) {
return (
-
+
)
diff --git a/apps/docs/pages/guides/platform/[[...slug]].tsx b/apps/docs/pages/guides/platform/[[...slug]].tsx
index 06340742556..f20307d7974 100644
--- a/apps/docs/pages/guides/platform/[[...slug]].tsx
+++ b/apps/docs/pages/guides/platform/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function PlatformGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/realtime/[[...slug]].tsx b/apps/docs/pages/guides/realtime/[[...slug]].tsx
index dddabae2a82..3a90134f5ad 100644
--- a/apps/docs/pages/guides/realtime/[[...slug]].tsx
+++ b/apps/docs/pages/guides/realtime/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function RealtimeGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/resources/[[...slug]].tsx b/apps/docs/pages/guides/resources/[[...slug]].tsx
index 1fb37bfe708..d73ad930fe5 100644
--- a/apps/docs/pages/guides/resources/[[...slug]].tsx
+++ b/apps/docs/pages/guides/resources/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function ResourcesGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/self-hosting/[[...slug]].tsx b/apps/docs/pages/guides/self-hosting/[[...slug]].tsx
index fee43e2be5b..c63d1c13b75 100644
--- a/apps/docs/pages/guides/self-hosting/[[...slug]].tsx
+++ b/apps/docs/pages/guides/self-hosting/[[...slug]].tsx
@@ -2,6 +2,7 @@ import { type GetStaticPaths, type GetStaticProps, type InferGetStaticPropsType
import { MDXRemote } from 'next-mdx-remote'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Layout from '~/layouts/DefaultGuideLayout'
import { getGuidesStaticPaths, getGuidesStaticProps } from '~/lib/docs'
@@ -21,7 +22,7 @@ export default function SelfHostingGuide({
const { hideToc, ...meta } = frontmatter
return (
-
+
)
diff --git a/apps/docs/pages/guides/self-hosting/analytics/config.tsx b/apps/docs/pages/guides/self-hosting/analytics/config.tsx
index 073411ca703..3946fc2c55c 100644
--- a/apps/docs/pages/guides/self-hosting/analytics/config.tsx
+++ b/apps/docs/pages/guides/self-hosting/analytics/config.tsx
@@ -3,6 +3,7 @@ import { MDXRemote } from 'next-mdx-remote'
import { serialize } from 'next-mdx-remote/serialize'
import components from '~/components'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import Param from '~/components/Params'
import Layout from '~/layouts/DefaultGuideLayout'
import { getAnalyticsConfigV0 } from '~/lib/mdx/getConfig'
@@ -27,6 +28,7 @@ export const Page = (props: InferGetStaticPropsType) => (
) => (
) => (
) => (
+
)
diff --git a/apps/docs/pages/handbook/contributing.mdx b/apps/docs/pages/handbook/contributing.mdx
deleted file mode 100644
index 5365b2fb9f9..00000000000
--- a/apps/docs/pages/handbook/contributing.mdx
+++ /dev/null
@@ -1,32 +0,0 @@
-import Layout from '~/layouts/DefaultGuideLayout'
-
-export const meta = {
- id: 'contributing',
- title: 'Contributing',
- description: 'Want to help?',
-}
-
-## How to contribute
-
-Supabase has many [open source repos](https://github.com/orgs/supabase/repositories). Some of the more popular ones are:
-
-- [Supabase](https://github.com/supabase/supabase) - Our Dashboard, Websites, and example apps
-- [Supabase-js](https://github.com/supabase/supabase-js) - A client-side library written in TypeScript
-- [Gotrue](https://github.com/supabase/gotrue) - Our auth server, written in Go
-- [Realtime](https://github.com/supabase/realtime) - A server for streaming changes from Postgres, written in Elixir
-- [browse all](https://github.com/orgs/supabase/repositories)
-
-Want to contribute? Why not jump into our GitHub repo and:
-
-- [Sponsor Supabase](https://github.com/sponsors/supabase).
-- [Answer Discussions](https://github.com/supabase/supabase/discussions).
-- Submit an issue to one of our [repos](https://github.com/orgs/supabase/repositories)
-- Report a performance issue or a part of the documentation that you find confusing.
-- Create a pull request in one of our [repos](https://github.com/orgs/supabase/repositories)
-- [Translate our Readme](https://github.com/supabase/supabase/issues/1341).
-- Try our products and give feedback.
-- Spread the word if you like what we are doing.
-
-export const Page = ({ children }) =>
-
- )
-}
diff --git a/apps/docs/pages/reference/analytics/config.tsx b/apps/docs/pages/reference/analytics/config.tsx
deleted file mode 100644
index 4db5c72958f..00000000000
--- a/apps/docs/pages/reference/analytics/config.tsx
+++ /dev/null
@@ -1,114 +0,0 @@
-import fs from 'fs'
-import matter from 'gray-matter'
-import components from '~/components/index'
-import { MDXRemote } from 'next-mdx-remote'
-import { serialize } from 'next-mdx-remote/serialize'
-
-import specFile from '~/spec/analytics_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(props) {
- return (
-
-
- )
-}
diff --git a/apps/docs/pages/reference/auth/config.tsx b/apps/docs/pages/reference/auth/config.tsx
deleted file mode 100644
index d9c1e5eacbf..00000000000
--- a/apps/docs/pages/reference/auth/config.tsx
+++ /dev/null
@@ -1,73 +0,0 @@
-import specFile from '~/spec/gotrue_v1_config.yaml' assert { type: 'yml' }
-import { Parameter } from '~/lib/refGenerator/refTypes'
-import ReactMarkdown from 'react-markdown'
-import Head from 'next/head'
-
-// Parameters are grouped on the page by tag
-const TAGS = ['general']
-
-export default function Config() {
- return (
- <>
-
- Auth config
-
-
- {specFile.info.description}
-
+
+
)
}
diff --git a/apps/docs/pages/guides/cli/github-action/[slug].tsx b/apps/docs/pages/guides/cli/github-action/[slug].tsx
index 049e3f1072d..d06701295e5 100644
--- a/apps/docs/pages/guides/cli/github-action/[slug].tsx
+++ b/apps/docs/pages/guides/cli/github-action/[slug].tsx
@@ -12,6 +12,7 @@ import { UrlTransformFunction, linkTransform } from '~/lib/mdx/plugins/rehypeLin
import remarkMkDocsAdmonition from '~/lib/mdx/plugins/remarkAdmonition'
import { removeTitle } from '~/lib/mdx/plugins/remarkRemoveTitle'
import remarkPyMdownTabs from '~/lib/mdx/plugins/remarkTabs'
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
// We fetch these docs at build time from an external repo
const org = 'supabase'
@@ -62,7 +63,7 @@ interface ActionDocsProps {
export default function ActionDocs({ source, meta }: ActionDocsProps) {
return (
- CLI configuration
- -{content}
+
+
-
+
+
+ {specFile.info.description}
+
+ CLI configuration
+ +{content}
+
+
+
+ On this page
+
+
-
-
-
- On this page
-
-
-
-
-
-
-
-
-
- {generatedSpec.info.title}
-{generatedSpec.info.description}
-
- {generatedSpec.operations.map((operation: any) => (
-
-
-
-
-
-
- {operation.responseList.length > 0 && (
- <>
-
- {operation.responseList.map((response: any) => (
-
-
- ))}
-
-
- )}
-
-
-
- ))}
-
-
- {/* Path Parameters */}
- {operation.parameters &&
- operation.parameters.filter((parameter) => parameter.in === 'path').length >
- 0 && (
-
- {operation.operation}
- {operation.fullPath}
-
-
-
- )}
-
- {/* Header Parameters */}
- {operation.parameters &&
- operation.parameters.filter((parameter) => parameter.in === 'header').length >
- 0 && (
- Path parameters
--
- {operation.parameters &&
- operation.parameters
- .filter((parameter: any) => parameter.in === 'path')
- .map((parameter: any) => (
-
-
- -- {parameter.example && ( -- {parameter.name} --- {parameter.required && ( --- REQUIRED -- )} -
{parameter.description}
-- Example: - - {parameter.example} - -- )} -
- ))}
-
-
- )}
- Header parameters
--
- {operation.parameters &&
- operation.parameters
- .filter((parameter: any) => parameter.in === 'header')
- .map((parameter: any) => (
-
-
- - {parameter.name} - - {parameter.required && 'required'} - --- Example: - - {parameter.example} - --
- ))}
-
Responses
-{response.description}
- {response?.content && response?.content['application/json'] && ( -
-
- {JSON.stringify(response.content['application/json'], null, 2)}
-
-
- )}
-
-
- )
-}
-export async function getServerSideProps() {
- // an array of ids of the intro sections for this library
- const introPages = ['analytics']
-
- const pages = [...introPages]
-
- // Grab custom markdown intro page files
- const allMarkdownDocs = await Promise.all(
- pages.map(async (x: any, i) => {
- const pathName = `docs/ref/analytics/${x}.mdx`
-
- const markdownExists = fs.existsSync(pathName)
-
- const fileContents = markdownExists ? fs.readFileSync(pathName, 'utf8') : ''
- const { data, content } = matter(fileContents)
-
- return {
- id: x,
- title: x,
- // ...content,
- meta: data,
- introPage: introPages.includes(x),
- content: content ? await serialize(content || '') : null,
- }
- })
- )
-
- return {
- props: {
- docs: allMarkdownDocs,
- },
- }
-}
diff --git a/apps/docs/pages/reference/api/[...slug].tsx b/apps/docs/pages/reference/api/[...slug].tsx
index 27760ce04d8..d9c72242668 100644
--- a/apps/docs/pages/reference/api/[...slug].tsx
+++ b/apps/docs/pages/reference/api/[...slug].tsx
@@ -1,18 +1,28 @@
-import apiCommonSections from '~/spec/common-api-sections.json' assert { type: 'json' }
-import specFile from '~/spec/transforms/api_v0_openapi_deparsed.json' assert { type: 'json' }
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import RefSectionHandler from '~/components/reference/RefSectionHandler'
import { flattenSections } from '~/lib/helpers'
import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths'
import handleRefStaticProps from '~/lib/mdx/handleRefStaticProps'
import { gen_v3 } from '~/lib/refGenerator/helpers'
+import apiCommonSections from '~/spec/common-api-sections.json' assert { type: 'json' }
+import specFile from '~/spec/transforms/api_v0_openapi_deparsed.json' assert { type: 'json' }
+
// @ts-ignore
const generatedSpec = gen_v3(specFile, 'wat', { apiUrl: 'apiv0' })
const sections = flattenSections(apiCommonSections)
const libraryPath = '/api'
export default function Config(props) {
- return
-
-
- {specFile.info.description}
-
- {specFile.info.title} Configuration
-
-
-
- {props.docs
- .filter((doc) => doc.introPage)
- .map((item) => (
-
- {TAGS.map((tag) =>
- specFile.parameters
- .filter((param: Parameter) => param.tags[0] === tag)
- .map((parameter: Parameter, index) => (
-
- {index === 0 &&
- ))
- )}
- {tag} Settings
} -
-
-
-
- - $ - {parameter.title} -
-
-
-
-
-
-
- {parameter.links &&
- parameter.links.map((link) => (
-
-
-
-
- Required:
- {parameter.required.toString()}
-
- Default:
-
-
- {parameter.default ? parameter.default.toString() : 'None'}
-
-
-
- {link.name}
-
-
- ))}
- See also:
-
-
-
-
-
-
-
- {generatedSpec.info.title}
-{generatedSpec.info.description}
-
- {generatedSpec.operations.map((operation: any) => (
-
-
-
-
-
-
- {operation.responseList.length > 0 && (
- <>
-
- {operation.responseList.map((response: any) => (
-
-
- ))}
-
-
- )}
-
-
-
- ))}
-
-
- {/* Path Parameters */}
- {operation.parameters &&
- operation.parameters.filter((parameter) => parameter.in === 'path').length >
- 0 && (
-
- {operation.operation}
- {operation.fullPath}
-
-
-
- )}
-
- {/* Header Parameters */}
- {operation.parameters &&
- operation.parameters.filter((parameter) => parameter.in === 'header').length >
- 0 && (
- Path parameters
--
- {operation.parameters &&
- operation.parameters
- .filter((parameter: any) => parameter.in === 'path')
- .map((parameter: any) => (
-
-
- -- {parameter.example && ( -- {parameter.name} --- {parameter.required && ( --- REQUIRED -- )} -
{parameter.description}
-- Example: - - {parameter.example} - -- )} -
- ))}
-
-
- )}
- Header parameters
--
- {operation.parameters &&
- operation.parameters
- .filter((parameter: any) => parameter.in === 'header')
- .map((parameter: any) => (
-
-
- - {parameter.name} - - {parameter.required && 'required'} - --- Example: - - {parameter.example} - --
- ))}
-
Responses
-{response.description}
- {response?.content && response?.content['application/json'] && ( -
-
- {JSON.stringify(response.content['application/json'], null, 2)}
-
-
- )}
-
-
-
- )
-}
diff --git a/apps/docs/pages/reference/cli/[...slug].tsx b/apps/docs/pages/reference/cli/[...slug].tsx
index 75b9088f7fa..779e04540b6 100644
--- a/apps/docs/pages/reference/cli/[...slug].tsx
+++ b/apps/docs/pages/reference/cli/[...slug].tsx
@@ -1,17 +1,25 @@
-import spec from '~/spec/cli_v1_commands.yaml' assert { type: 'yml' }
-
-import { flattenSections } from '~/lib/helpers'
-
-import cliCommonSections from '~/spec/common-cli-sections.json' assert { type: 'json' }
+import { MenuId } from '~/components/Navigation/NavigationMenu/NavigationMenu'
import RefSectionHandler from '~/components/reference/RefSectionHandler'
+import { flattenSections } from '~/lib/helpers'
import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths'
import handleRefStaticProps from '~/lib/mdx/handleRefStaticProps'
+import spec from '~/spec/cli_v1_commands.yaml' assert { type: 'yml' }
+import cliCommonSections from '~/spec/common-cli-sections.json' assert { type: 'json' }
+
const sections = flattenSections(cliCommonSections)
const libraryPath = '/cli'
export default function CliRef(props) {
- return
-
-
- {specFile.info.description}
-
- {specFile.info.title} Configuration
-
- {TAGS.map((tag) =>
- specFile.parameters
- .filter((param: Parameter) => param.tags[0] === tag)
- .map((parameter: Parameter, index) => (
-
-
- {index === 0 &&
- ))
- )}
- {tag}
} -
-
-
-
- - $ - {parameter.title} -
-
-
-
-
-
-
- {parameter.links &&
- parameter.links.map((link) => (
-
-
-
-
- Required:
- {parameter.required.toString()}
-
- Default:
-
-
- {parameter.default ? parameter.default.toString() : 'None'}
-
-
-
- {link.name}
-
-
- ))}
-