One

主题

页脚配置 ​

social ​

社交信息配置，通常为一个社交图标，点击后将会跳转到社交软件的个人主页。

支持在首页 index.md 的 frontmatter 配置，格式为 tk.social.[key]。

提示

social 在卡片栏的博主信息区和页脚都会生效。

ts
const tkConfig = tkThemeConfig({
  social: [
    {
      icon: "icon-github",
      iconType: "iconfont",
      name: "GitHub",
      link: "https://github.com/kele-bingtang",
    },
    {
      icon: "icon-gitee2",
      iconType: "iconfont",
      name: "Gitee",
      link: "https://gitee.com/kele-bingtang",
    },
    {
      icon: "icon-mobile",
      iconType: "iconfont",
      name: "联系我",
      link: "https://www.youngkbt.cn/?contact=true",
    },
  ],
});
yaml
---
tk:
  social:
    - icon: icon-github
      iconType: iconfont
      name: GitHub
      link: https://github.com/kele-bingtang
    - icon: icon-gitee2
      iconType: iconfont
      name: Gitee
      link: https://gitee.com/kele-bingtang
    - icon: icon-mobile
      iconType: iconfont
      name: 联系我
      link: https://www.youngkbt.cn/?contact=true
---
ts
interface TkThemeConfig {
  /**
   * 社交配置
   */
  social?: Social[];
}

interface Social {
  /**
   * 名称，如果作用在 a 标签，则鼠标悬停显示名称，否则在页面文字显示
   */
  name?: string;
  /**
   * 图标地址
   *
   * @remark 与 iconType 配合使用
   *
   * 1、iconType 为 svg 时，需要填写 svg 代码
   * 2、iconType 为 iconfont 时，需要填写 class 名
   * 3、iconType 为 img 时，需要填写图片链接
   * 4、iconType 为 component 时，需要传入 SVG 组件
   */
  icon?: string;
  /**
   * 图标类型
   *
   * @default 'svg'
   */
  iconType?: "svg" | "iconfont" | "img" | "component";
  /**
   * 链接，点击后跳转到新窗口，如果不设置，则无法点击
   */
  link?: string;
  /**
   * img 标签的 alt，当 iconType 为 img 时生效
   */
  imgAlt?: string;
}

footerInfo ​

页脚配置，不会影响 Vitepress 自带的页脚功能。

支持在首页 index.md 的 frontmatter 配置，格式为 tk.social.[key]。

配置项中的 Social 类型为 Social 配置项。

ts
const tkConfig = tkThemeConfig({
  footerInfo: {
    message: ["下面的内容和图标都可以修改（本条内容也可以隐藏的）"], // 页脚信息
    // 博客版权配置
    copyright: {
      createYear: 2021, // 创建年份
      suffix: "天客 Blog", // 后缀
    },
    // ICP 备案信息配置
    icpRecord: {
      name: "桂ICP备2021009994号",
      link: "http://beian.miit.gov.cn/",
    },
  },
});
yaml
---
tk:
  footerInfo:
    message:
      - 下面的内容都可以修改（本条内容也可以隐藏的）
    copyright:
      createYear: 2021
      suffix: 天客 Blog
    icpRecord:
      name: 桂ICP备2021009994号
      link: http://beian.miit.gov.cn/
---
ts
interface TkThemeConfig {
  /**
   * 页脚配置
   */
  footerInfo?: FooterInfo;
}

interface FooterInfo {
  /**
   * 页脚信息
   */
  message?: string | string[];
  /**
   * 主题版权配置
   */
  theme?: Social;
  /**
   * 博客版权配置
   */
  copyright?: Social & {
    /**
     * 创建年份
     */
    createYear: number | string;
    /**
     * 后缀
     */
    suffix: string;
  };
  /**
   * ICP 备案信息配置
   */
  icpRecord?: Social;
  /**
   * 网络安全备案信息配置
   */
  securityRecord?: Social;
  /**
   * 自定义 HTML 片段到 footer 最底部
   */
  customerHtml?: string;
}