0.0.22 • Published 10 months ago
dumi-theme-chakra v0.0.22
Usage
# npm
$ npm i dumi-theme-chakra -D
# yarn
$ yarn add dumi-theme-chakra -D
# pnpm
$ pnpm add dumi-theme-chakra -D
Configure
在 dumi 的配置文件 .dumirc.ts
中配置主题相关
import { defineConfig } from 'dumi';
import { defineThemeConfig } from 'dumi-theme-chakra';
export defineConfig({
themeConfig: {
...defineThemeConfig({
// ...
})
},
});
Options
export type ThemeConfig = DocProviderProps & {
/**
* @description.zh-CN 社交配置: 比如 github & discord
*/
social?: SocialMap;
/**
* @description.zh-CN 自动生成的title分隔符: 格式为: ${themeConfig.title} ${helmetIcon} ${subTitle}
*/
helmetIcon?: string;
/**
* @description.zh-CN 自定义header meta 描述信息
*/
description?: string;
/**
* @description.zh-CN 自定义header meta 关键字
*/
keywords?: string[];
/**
* @description.zh-CN 自定义header meta 作者
*/
author?: string;
/**
* @description.zh-CN 是否使用搜索. 若为布尔值则表示开启或关闭. 也可以使用对象来配置更多
* @default true
*/
search?: boolean | Search;
/**
* @description.zh-CN 文档头部声明条幅配置
*/
announcementBar?: AnnouncementBarConfig;
/**
* @description.zh-CN 首页的hero配置
*/
hero?: HeroConfig;
/**
* @description.zh-CN 文档背景图片. 如果为布尔值, 使用默认背景图片
* @default false
*/
thumbBackground?: boolean | string;
/**
* @description.zh-CN 是否展示主题设置面板
* @default false
*/
settingPanelVisible?: boolean;
/**
* @description.zh-CN <SourceCode /> 组件配置
*/
code?: {
/**
* @description.zh-CN prism themes
* @default { dark: PRISMTHEME.VSDARK, light: PRISMTHEME.VSLIGHT }
*/
theme?: CodeTheme;
};
};
详情查看
Contribution
查看 贡献指南.
License
MIT.
Sponsoring
0.0.20
10 months ago
0.0.21
10 months ago
0.0.22
10 months ago
0.0.19
10 months ago
0.0.16
12 months ago
0.0.17
12 months ago
0.0.18
11 months ago
0.0.13
1 year ago
0.0.14
1 year ago
0.0.15
1 year ago
0.0.10
1 year ago
0.0.11
1 year ago
0.0.12
1 year ago
0.0.9
1 year ago
0.0.8
1 year ago
0.0.3
1 year ago
0.0.2
1 year ago
0.0.5
1 year ago
0.0.4
1 year ago
0.0.7
1 year ago
0.0.6
1 year ago
0.0.1
1 year ago