diff --git a/src/extend.ts b/src/extend.ts index 72fc2f3..4f0eac4 100644 --- a/src/extend.ts +++ b/src/extend.ts @@ -7,6 +7,10 @@ import type { ExtendOptions } from './types.ts'; /** * Extend theme to UnoCSS by using `extendTheme` function. + * + * @param options - Options for extending the theme. + * @returns The main function that supposed to be passed + * to UnoCSS `extendTheme` option. */ export const _extendTheme = ( options: ExtendOptions = {}, diff --git a/src/index.ts b/src/index.ts index 94e1867..8ca7c32 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,8 +4,12 @@ import type { Preset } from '@unocss/core'; import type { UnoCSSCatppuccinOptions } from './types.ts'; +// TODO: Fix docs /** - * Extend theme to UnoCSS by using `extendTheme` function. + * Catppuccin preset for UnoCSS. + * + * @param options - Options for the preset. + * @returns The UnoCSS preset object. */ export const presetCatppuccin = ( options: UnoCSSCatppuccinOptions = { mode: 'extend' }, diff --git a/src/types.ts b/src/types.ts index e23a7f3..984d229 100644 --- a/src/types.ts +++ b/src/types.ts @@ -136,7 +136,7 @@ export interface UnoCSSCatppuccinOptions extends PresetOptions { } /** - * Options for the `_extendTheme` function. + * Options for the internal `_extendTheme` function. * * Picks `prefix` and `defaultFlavour` from {@link UnoCSSCatppuccinOptions}. */