The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import type { BlockContent, Content, Paragraph, Root } from 'mdast'
import type { MdxJsxFlowElement } from 'mdast-util-mdx'
import type { AdmonitionProps } from 'ui-patterns/Admonition'
import type { Node } from 'unist'
import { visit } from 'unist-util-visit'
/**
* Transforms an `mkdocs-material` Admonition to a Supabase Admonition.
*
* https://squidfunk.github.io/mkdocs-material/reference/admonitions/
*/
const remarkMkDocsAdmonition = function () {
return function transformer(root: Root) {
visit(root, 'paragraph', (paragraph: Paragraph, index: number, parent: Root) => {
const [firstChild] = paragraph.children
if (firstChild?.type === 'text') {
// Look for 3 '!', followed by an admonition type, followed by
// an optionally quoted title, followed by optional newlines of text
const match = firstChild.value.match(/^!!! ?("?)(.+)\1 ?\n?((?:.|\n)*)/)
if (!match) {
return
}
// Extract the admonition type, title, and remaining text
const [, , typeTitle, value] = match
const typeTitleMatch = typeTitle.match(/^(.+?) ?(?:"(.*)")?$/)
if (!typeTitleMatch) return
const [, type, title] = typeTitleMatch
// Rewrite the node's value to remove the admonition syntax
firstChild.value = value
// Extract sibling nodes that should be linked to this admonition
const siblingsToNest = extractLinkedSiblings(parent, paragraph, index)
const inlineChildren = paragraph.children.filter((child) => {
if (child.type === 'text') return child.value.trim().length > 0
return true
})
// Wrap inline content in a single paragraph so MDX does not emit one <p> per node.
const children: MdxJsxFlowElement['children'] = [
...(inlineChildren.length > 0
? [{ type: 'paragraph' as const, children: inlineChildren }]
: []),
...siblingsToNest,
]
// Generate a Supabase Admonition JSX element
const admonitionElement: MdxJsxFlowElement = {
type: 'mdxJsxFlowElement',
name: 'Admonition',
attributes: [
{
type: 'mdxJsxAttribute',
name: 'type',
value: mapAdmonitionType(type),
},
],
children,
}
if (title) {
admonitionElement.attributes.push({
type: 'mdxJsxAttribute',
name: 'title',
value: title,
})
}
// Overwrite original node with new element
parent.children.splice(index, 1, admonitionElement)
}
})
return root
}
}
/**
* Identifies sibling nodes that should be linked to this admonition
* based on their indent level (ie. 4 spaces).
*
* Iterates through proceeding siblings until one is found that is
* not indented relative to the original node.
*
* Splices the discovered siblings out of the original parent and returns them.
*/
function extractLinkedSiblings(
parent: Root,
node: Node,
index: number,
indentAmount = 4
): BlockContent[] {
const { column } = node.position?.start || { column: 0 }
let nextSibling: Content
let i = index
do {
nextSibling = parent.children[++i]
} while (nextSibling?.position && nextSibling.position.start.column === column + indentAmount)
return parent.children.splice(index + 1, i - index - 1) as BlockContent[]
}
/**
* Maps `mkdocs-material` Admonition types to Supabase Admonition types.
*
* https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
*/
function mapAdmonitionType(type: string): AdmonitionProps['type'] {
switch (type) {
case 'quote':
case 'example':
case 'note':
case 'tip':
return 'note'
case 'warning':
return 'caution'
case 'failure':
case 'bug':
case 'danger':
return 'danger'
case 'abstract':
case 'question':
case 'info':
default:
return 'note'
}
}
export default remarkMkDocsAdmonition