test/node_modules/@vuepress/theme-default/lib/shared/page.d.ts
2024-08-13 09:27:52 +08:00

44 lines
1.3 KiB
TypeScript

import type { GitPluginPageData } from '@vuepress/plugin-git';
import type { AutoLinkConfig } from 'vuepress/client';
import type { SidebarArrayOptions } from './sidebar.js';
export interface DefaultThemePageData extends GitPluginPageData {
filePathRelative: string | null;
}
export interface DefaultThemePageFrontmatter {
home?: boolean;
navbar?: boolean;
pageClass?: string;
externalLinkIcon?: boolean;
}
export interface DefaultThemeHomePageFrontmatter extends DefaultThemePageFrontmatter {
home: true;
heroImage?: string;
heroImageDark?: string;
heroAlt?: string;
heroHeight?: number;
heroText?: string | null;
tagline?: string | null;
actions?: {
text: string;
link: string;
type?: 'primary' | 'secondary';
}[];
features?: {
title: string;
details: string;
}[];
footer?: string;
footerHtml?: boolean;
}
export interface DefaultThemeNormalPageFrontmatter extends DefaultThemePageFrontmatter {
home?: false;
editLink?: boolean;
editLinkPattern?: string;
lastUpdated?: boolean;
contributors?: boolean;
sidebar?: false | 'heading' | SidebarArrayOptions;
sidebarDepth?: number;
prev?: string | AutoLinkConfig;
next?: string | AutoLinkConfig;
}