vuepress-theme-plume/docs/config/frontmatter/friend.md

title, createTime, permalink

title	createTime	permalink
友情链接页	2024/03/03 18:00:52	/config/frontmatter/friends/

概述

适用于友情链接页。

示例：

---
pageLayout: friends
title: 友情链接
cols: 2
list:
  -
    name: pengzhanbo
    link: https://github.com/pengzhanbo
    avatar: https://github.com/pengzhanbo.png
    location: 广州，中国
    organization: VuePress
    desc: 即使慢，驰而不息，纵会落后，纵会失败，但必须能够到达他所向的目标。
    socials:
      -
        icon: github
        link: https://github.com/pengzhanbo
      -
        icon: twitter
        link: https://twitter.com/pengzhanbo
---

配置

friends

• 类型： boolean

• 默认值： false

• 详情：

  当前页面是否为友情链接页。

pageLayout

• 类型：'friends'

• 详情：

  声明当前页面为 友情链接页。

title

• 类型： string
• 默认值： 友情链接

友情链接页的标题

description

• 类型： string

友情链接页的描述

contentPosition

• 类型： 'before' | 'after'
• 默认值： 'after'

markdown 内容在友情链接列表之前还是之后，默认插入到列表之后。

cols

• 类型： number
• 默认值： 2

友情链接列表每行最大显示的列数，一般设置为 2 / 3 时最佳。

list

• 类型： FriendsItem[]
• 默认值: []

友情链接列表

interface FriendsItem {
  /**
   * 友情链接名
   */
  name: string
  /**
   * 友情链接
   */
  link: string
  /**
   * 友情链接头像
   */
  avatar?: string
  /**
   * 友情链接描述
   */
  desc?: string
  /**
   * 地理位置
   */
  location?: string
  /**
   * 组织、公司
   */
  organization?: string

  /**
   * 社交链接
   */
  socials?: SocialLink[]

  /**
   * 背景色
   */
  backgroundColor?: string | { light: string, dark: string }
  /**
   * 字体颜色
   */
  color?: string | { light: string, dark: string }
  /**
   * 名字颜色
   */
  nameColor?: string | { light: string, dark: string }
}

社交链接配置请查看 配置/主题配置/社交链接。

groups

• 类型： FriendsGroup[]
• 默认值: []

友情链接分组

interface FriendsGroup {
  /**
   * 分组名
   */
  title?: string
  /**
   * 分组描述
   */
  desc?: string
  /**
   * 友情链接列表
   */
  list?: FriendsItem[]
}