dumi-theme-antd-style/dist/types/config.d.ts

dumi-theme-antd-style 是为 dumi2 打造的一款文档站主题包，提供了更加美观、易用的研发与阅读体验

import { FooterColumn } from 'rc-footer/es/column';
import { SiteToken } from '../styles';
import { ApiHeaderConfig, HighlighterSyntaxTheme, IHero } from '../types';
/**
 * @title 页面底部 Footer 组件的配置
 */
export interface IFooter {
    /**
     * @title 左下内容
     */
    copyright?: string;
    /**
     * @title 底部内容
     */
    bottom?: string;
    /**
     * @title 主题
     * @enum ['dark', 'light']
     * @enumNames ['黑色', '白色']
     */
    theme?: 'dark' | 'light';
    /**
     * @title 列配置
     */
    columns?: FooterColumn[] | false;
}
/**
 * 网站主题配置
 */
export interface SiteThemeConfig {
    /**
     * 网站名称
     */
    name?: string;
    /**
     * 网站 logo 图片链接
     */
    logo?: string;
    /**
     * 导航栏 Github 图标链接，如不配置该字段，则不展示。
     */
    github?: string;
    /**
     * 网站首页头部
     * @type IHero | Record<string, IHero>
     */
    hero?: IHero | Record<string, IHero>;
    /**
     * API 文档页头部配置
     * @type ApiHeaderConfig | false
     */
    apiHeader?: ApiHeaderConfig | false;
    /**
     * 网站页脚
     * @type string | false
     */
    footer?: string | false;
    /**
     * 网站页脚配置
     * @type IFooter
     */
    footerConfig?: IFooter;
    /**
     * 代码高亮主题配置
     * @type HighlighterSyntaxTheme
     */
    syntaxTheme?: HighlighterSyntaxTheme;
    /**
     * 是否隐藏首页的 nav tab，配置为 `true` 则不展示首页的 tab
     */
    hideHomeNav?: boolean;
    /**
     * 是否隐藏header的name部分，配置为 `true` 则不展示header的name部分
     */
    hideNameOnHeader?: boolean;
    /**
     * 网站主题 Token 配置
     */
    siteToken?: SiteConfigToken;
    socialLinks?: {
        github?: string;
        weibo?: string;
        twitter?: string;
        gitlab?: string;
        facebook?: string;
        zhihu?: string;
        yueque?: string;
        linkedin?: string;
    };
}
export type SiteConfigToken = Partial<Pick<SiteToken, 'headerHeight' | 'footerHeight' | 'sidebarWidth' | 'tocWidth' | 'contentMaxWidth' | 'demoInheritSiteTheme'>>;