Опции макета темы

Около 2 мин

Следующие параметры управляют макетом темы.

Конфигурация панели навигации

Соответствующее руководство смотрите в разделе Макет → Панель навигации.

Тип: NavbarConfig | false
По умолчанию: false

Конфигурация панели навигации

navbarIcon

Тип: boolean
По умолчанию: true

Отображать ли иконки в навигационной панели.

navbarLayout

Тип: HopeNavbarLayoutOptions

type NavbarComponent =
  | "Brand"
  | "Links"
  | "Language"
  | "Search"
  | "Outlook"
  | "Repo";

interface HopeNavbarLayoutOptions {
  start: NavbarComponent[];
  center: NavbarComponent[];
  end: NavbarComponent[];
}

По умолчанию: { start: ["Brand"], center: ["Links"], end: ["Language", "Repo", "Outlook", "Search"] }

Настройте макет панели навигации.

logo Рекомендуется

Тип: string
Обязательный: Нет

Логотип панели навигации должен быть абсолютным путем относительно папки .vuepress/public.

logoDark

Тип: string
Обязательный: Нет

Логотип Navbar в темном режиме должен быть абсолютным путем относительно папки .vuepress/public.

repo

Тип: string
Обязательный: Нет

Ссылка на репозиторий.

repoDisplay

Тип: boolean
По умолчанию: true

Отображать ли ссылку на репозиторий в панели навигации.

repoLabel

Тип: string
Обязательный: Нет

Ярлык репозитория навигационной панели.

Заметка

Тема может распознавать ссылки GitHub, Gitlab, Gitee и Bitbucket.

navbarAutoHide

Тип: "always" | "mobile" | "none"
По умолчанию: "mobile"

Скрывать ли панель навигации при прокрутке вниз.

hideSiteNameOnMobile

Тип: boolean
По умолчанию: true

Скрыть ли заголовок сайта на мобильном телефоне.

Конфигурация боковой панели

Руководство смотрите в разделе Макет → Боковая панель.

Тип: SidebarConfig | "structure" | "heading" | false
По умолчанию: "structure"

Конфигурация боковой панели.

sidebarIcon

Тип: boolean
По умолчанию: true

Показывать ли иконки на боковой панели.

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[];

По умолчанию: ["readme", "order", "title", "filename"]

Структура сортировки боковой панели.

Вы можете:

заполнить пользовательскую функцию
предоставить одно ключевое слово сортировщика
предоставить массив пользовательской функции или ключевого слова сортировщика

Доступные ключевые слова:

readme: сначала README.md или readme.md
order: положительный порядок сначала с его значением по возрастанию, отрицательный порядок последним с его значением по убыванию
date: сортировка по дате по возрастанию
date-desc: сортировка по дате по убыванию
title: сортировка по названию в алфавитном порядке
filename: сортировка по алфавиту по имени файла