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

Около 3 минКонфигКонфиг темыМакет

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

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

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

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

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

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

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

  • Тип: 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"] }

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

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

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

logoDark

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

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

repo

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

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

repoDisplay

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

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

repoLabel

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

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

Заметка

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

  • Тип: "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;
    
      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"]

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

Вы можете:

  • fill in a custom function
  • provide one sorter keyword
  • provide an array of custom function or sorter keyword

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

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

headerDepth

  • Тип: number
  • По умолчанию: 2

Глубина вложенных заголовков в боковой панели.

Навигация по маршруту

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

Включить ли навигацию по маршруту глобально.

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

Показывать ли иконки в навигации по маршруту.

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

Показывать ли предыдущую ссылку внизу.

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

Показывать ли следующую ссылку внизу.

Заголовок

titleIcon

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

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

pageInfo

  • Тип: ArticleInfo[] | false
  • По умолчанию: ["Author", "Original", "Date", "Category", "Tag", "ReadingTime"]

Информация о статье. Порядок элементов определяет порядок отображения. Заполните false, чтобы отключить его.

Доступные элементы в ArticleInfo:

  • "Author": автор
  • "Date": дата написания
  • "Original": является оригинальным
  • "Category": категория
  • "Tag": теги
  • "ReadingTime": ожидаемое время чтения
  • "Word": номер слова для статьи
  • "PageView": просмотры страниц

Мета

lastUpdated

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

Показывать ли «Последнее обновление» или нет.

contributors

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

Показывать ли «Контрибьюторы» или нет.

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

Показывать ли «Редактировать эту страницу» или нет.

editLinkPattern

  • Тип: string

Шаблон редактирования ссылки. В то время как :repo :branch :path будет автоматически заменен на docsRepo docsBranch и docsDir + filePath

Заметка

Тема обеспечивает встроенную поддержку GitHub, Gitlab, Gitee и Bitbucket.

docsRepo

  • Тип: string
  • По умолчанию: repo

Репозиторий вашей документации.

docsBranch

  • Тип: string
  • По умолчанию: "main"

Ветка вашей документации.

docsDir

  • Тип: string
  • По умолчанию: ""

Расположение каталога документации в репозитории.

Футер

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

Содержимое нижнего колонтитула по умолчанию может принимать HTMLString.

  • Тип: string | boolean
  • По умолчанию: "Copyright © <author>"

Информация об авторских правах по умолчанию, установите для нее значение false, чтобы отключить ее по умолчанию.

displayFooter

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

Отображать ли нижний колонтитул по умолчанию.

Другое

home

  • Тип: string
  • По умолчанию: Key of current locale

Домашний путь текущей локали, используемый в качестве ссылки для возврата домой и логотипа панели навигации.

rtl

  • Type: boolean
  • Default: false

Whether use RTL layout.

toc

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

Показывать ли toc list в режиме рабочего стола.