主题布局选项

大约 4 分钟

以下选项控制主题布局。

导航栏

类型: NavbarConfig | false
默认值: false
详情:
- 布局 → 导航栏 → 导航栏链接
- 布局 → 导航栏 → 禁用导航栏

导航栏配置。

navbarLayout

类型: NavbarLayoutOptions

/**
 * 内置导航栏组件
 */
type NavbarComponent =
  | "Brand"
  | "Links"
  | "Language"
  | "Search"
  | "Outlook"
  | "Repo";

/**
 * 导航栏布局选项
 */
interface NavbarLayoutOptions {
  start?: (NavbarComponent | string)[];
  center?: (NavbarComponent | string)[];
  end?: (NavbarComponent | string)[];
}

默认值: { start: ["Brand"], center: ["Links"], end: ["Language", "Repo", "Outlook", "Search"] }
详情:
- 布局 → 导航栏 → 导航栏布局

自定义导航栏布局。

logo 建议配置

类型: string
必填: 否

导航栏图标，应为基于 .vuepress/public 文件夹的绝对路径。

logoDark

类型: string
默认值: logo

夜间模式下导航栏图标，应为基于 .vuepress/public 文件夹的绝对路径。

navbarTitle

类型: string
默认值: $siteLocale.title

导航栏标题，你可以设置为 '' 来隐藏它。

repo

类型: string
必填: 否

仓库配置，用于在导航栏中显示仓库链接。

repoDisplay

类型: boolean
默认值: true

是否在导航栏显示仓库链接。

repoLabel

类型: string
必填: 否

用于导航栏仓库按钮的无障碍标签。

注

主题可以正确识别 GitHub, Gitlab, Gitee, Bitbucket 的链接。

navbarAutoHide

类型: "always" | "mobile" | "none"
默认值: "mobile"

是否在向下滚动时自动隐藏导航栏。

hideSiteNameOnMobile

类型: boolean
默认值: true

是否在移动视图下隐藏站点名称。

侧边栏

关于配置指南，详见布局 → 侧边栏。

类型: SidebarConfig | "structure" | false
默认值: "structure"

侧边栏配置。

sidebarSorter 仅限 Root

类型: SidebarSorter

interface SidebarFileInfo {
  type: "file";
  filename: string;

  title: string;
  order: number | null;
  path?: string | null;

  frontmatter: ThemeNormalPageFrontmatter;
  pageData: ThemePageData;
}

interface SidebarDirInfo {
  type: "dir";
  dirname: string;
  children: SidebarInfo[];

  title: string;
  order: number | null;

  groupInfo: {
    icon?: string;
    collapsible?: boolean;
    link?: string;
  };

  frontmatter: ThemeNormalPageFrontmatter | null;
  pageData: ThemePageData | null;
}

type SidebarInfo = SidebarFileInfo | SidebarDirInfo;

type SidebarSorterKeyword =
  | "readme"
  | "order"
  | "date"
  | "date-desc"
  | "filename"
  | "title";

type SidebarSorterFunction = (
  infoA: SidebarInfo,
  infoB: SidebarInfo,
) => number;

type SidebarSorter =
  | SidebarSorterFunction
  | SidebarSorterFunction[]
  | SidebarSorterKeyword
  | SidebarSorterKeyword[];