Skip to content

Sidebar

Типизированная навигация

defineDocSidebar() объявляет дерево навигации VitePress. Оно владеет порядком и вложенностью, поэтому page definitions не нужны parentId или order.

DocSidebarItem описывает дерево навигации. Элементы могут иметь произвольную вложенность и ссылаться на найденные файлы страниц.

ts
export interface DocSidebarItem {
  page: string;
  text?: string;
  description?: string;
  collapsed?: boolean;
  /**
   * Страница валидируется (не даёт "Page is not present in sidebar"), но не
   * попадает в сгенерированный sidebar — доступна только по прямой ссылке.
   */
  hidden?: boolean;
  items?: DocSidebarItem[];
}

Mentioned In