minor changes

This commit is contained in:
sebastien 2025-04-11 17:30:10 +02:00
parent 1460e06d21
commit 7afade4199

View file

@ -28,7 +28,7 @@ type TitleFormatterParams = {
}; };
/** /**
* This is the full formatting function * This is the full formatting function, including all useful params
* Can be customized through React context with the provider * Can be customized through React context with the provider
*/ */
export type TitleFormatterFn = (params: TitleFormatterParams) => string; export type TitleFormatterFn = (params: TitleFormatterParams) => string;
@ -36,7 +36,7 @@ export type TitleFormatterFn = (params: TitleFormatterParams) => string;
/** /**
* The default formatter is provided in params for convenience * The default formatter is provided in params for convenience
*/ */
export type TitleFormatterFnWithDefaultFormatter = ( export type TitleFormatterFnWithDefault = (
params: TitleFormatterParams & { params: TitleFormatterParams & {
defaultFormatter: (params: TitleFormatterParams) => string; defaultFormatter: (params: TitleFormatterParams) => string;
}, },
@ -66,7 +66,7 @@ export function TitleFormatterProvider({
children, children,
}: { }: {
children: ReactNode; children: ReactNode;
formatter: TitleFormatterFnWithDefaultFormatter; formatter: TitleFormatterFnWithDefault;
}): ReactNode { }): ReactNode {
const {siteConfig} = useDocusaurusContext(); const {siteConfig} = useDocusaurusContext();
const {title: siteTitle, titleDelimiter} = siteConfig; const {title: siteTitle, titleDelimiter} = siteConfig;