fumadocs-core
Version:
The React.js library for building a documentation website
41 lines • 1.19 kB
TypeScript
//#region src/i18n/index.d.ts
interface I18nConfig<Languages extends string = string> {
/**
* Supported locale codes.
*
* A page tree will be built for each language.
*/
languages: Languages[];
/**
* Default locale if not specified
*/
defaultLanguage: Languages;
/**
* Don't show the locale prefix on URL.
*
* - `always`: Always hide the prefix
* - `default-locale`: Only hide the default locale
* - `never`: Never hide the prefix
*
* This API uses `NextResponse.rewrite`.
*
* @defaultValue 'never'
*/
hideLocale?: 'always' | 'default-locale' | 'never';
/**
* Used by `loader()`, specify the way to parse i18n file structure.
*
* @defaultValue 'dot'
*/
parser?: 'dot' | 'dir' | 'none';
/**
* the fallback language when the page has no translations available for a given locale.
*
* Default to ``defaultLanguage`, no fallback when set to `null`.
*/
fallbackLanguage?: Languages | null;
}
declare function defineI18n<Languages extends string>(config: I18nConfig<Languages>): I18nConfig<Languages>;
//#endregion
export { defineI18n as n, I18nConfig as t };
//# sourceMappingURL=index-Bw-DCOra.d.ts.map