Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
catuhana committed Jul 19, 2024
1 parent e6fe3a1 commit 271a0c7
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions src/extend.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 = <Theme extends object = object>(
options: ExtendOptions = {},
Expand Down
6 changes: 5 additions & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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' },
Expand Down
2 changes: 1 addition & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
*/
Expand Down

0 comments on commit 271a0c7

Please sign in to comment.