docs: add headings containing only code to ToC (#467)

Co-authored-by: Marco Pasqualetti <marco.pasqualetti@live.com>
This commit is contained in:
Jacob Marshall
2025-01-30 07:48:07 +00:00
committed by GitHub
parent ad0b09c3df
commit 01b90b327e
@@ -2,40 +2,46 @@ import type { ElementType, JSX, ReactNode } from 'react'
import { Title, type TitleProps } from '@mantine/core' import { Title, type TitleProps } from '@mantine/core'
export default function MdxTitle(props: TitleProps): JSX.Element { export default function MdxTitle(props: TitleProps): JSX.Element {
const headingId = getIdFrom(props.children)
return ( return (
<Title <Title
data-heading={props.children} data-heading={headingId}
data-order={props.order} data-order={props.order}
style={{ scrollMargin: 70 }} style={{ scrollMargin: 70 }}
{...props} {...props}
id={idGen(props.children)} id={headingId}
/> />
) )
} }
function idGen(children: ReactNode): string { function getIdFrom(children: ReactNode): string {
if (Array.isArray(children)) { const getTextContent = (node: ReactNode): string => {
const result = children if (typeof node === 'string') return node
.map((child) => { if (typeof node === 'object' && node !== null && 'props' in node) {
if (typeof child === 'string') { const child = node as { props?: { children?: ReactNode } }
return child return getTextContent(child.props?.children)
} }
if (typeof child === 'object' && child !== null && 'props' in child) { return ''
const childWithProps = child as { props?: { children?: ReactNode } }
return typeof childWithProps.props?.children === 'string'
? childWithProps.props.children
: ''
}
return ''
})
.join('')
return result.toLowerCase().replace(/\s+/g, '-')
} }
return typeof children === 'string' const textContent = Array.isArray(children)
? children.toLowerCase().replace(/\s+/g, '-') ? children.map(getTextContent).join('')
: '' : getTextContent(children)
return (
textContent
// normalize cause tuono build --static to hang
// @see https://github.com/tuono-labs/tuono/issues/468
// .normalize('NFKD')// separate accented characters into their base form and diacritical marks
.replace(/[\u0300-\u036f]/g, '') // remove all the accents
.trim()
.toLowerCase()
.replace(/\./g, '-') // some titles (configuration) contain keypath, so replace dots with hyphens
.replace(/[^a-z0-9 -]/g, '') // remove non-alphanumeric characters
.replace(/\s+/g, '-') // replace spaces with hyphens
.replace(/-+/g, '-') // remove consecutive hyphens
)
} }
export const h = (order: 1 | 2 | 3 | 4 | 5 | 6): ElementType<TitleProps> => { export const h = (order: 1 | 2 | 3 | 4 | 5 | 6): ElementType<TitleProps> => {
@@ -43,5 +49,6 @@ export const h = (order: 1 | 2 | 3 | 4 | 5 | 6): ElementType<TitleProps> => {
return <MdxTitle order={order} {...props} /> return <MdxTitle order={order} {...props} />
} }
render.displayName = 'H' render.displayName = 'H'
return render return render
} }