quartz-research-note/quartz/cfg.ts

31 lines
927 B
TypeScript
Raw Normal View History

2023-07-01 07:03:01 +00:00
import { QuartzComponent } from "./components/types"
import { PluginTypes } from "./plugins/types"
2023-06-01 21:35:31 +00:00
import { Theme } from "./theme"
2023-05-30 15:02:20 +00:00
2023-06-01 21:35:31 +00:00
export interface GlobalConfiguration {
/** Whether to enable single-page-app style rendering. this prevents flashes of unstyled content and improves smoothness of Quartz */
enableSPA: boolean,
2023-07-01 07:03:01 +00:00
/** Whether to display Wikipedia-style popovers when hovering over links */
enablePopovers: boolean,
2023-06-01 21:35:31 +00:00
/** Glob patterns to not search */
ignorePatterns: string[],
theme: Theme
2023-05-30 15:02:20 +00:00
}
export interface QuartzConfig {
2023-06-01 21:35:31 +00:00
configuration: GlobalConfiguration,
2023-05-30 15:02:20 +00:00
plugins: PluginTypes,
}
2023-07-01 07:03:01 +00:00
export interface FullPageLayout {
head: QuartzComponent
header: QuartzComponent[],
beforeBody: QuartzComponent[],
pageBody: QuartzComponent,
left: QuartzComponent[],
right: QuartzComponent[],
footer: QuartzComponent,
}
export type PageLayout = Pick<FullPageLayout, "beforeBody" | "left" | "right">