2023-07-01 10:03:01 +03:00
|
|
|
import { QuartzComponent } from "./components/types"
|
2023-06-01 00:01:23 +03:00
|
|
|
import { PluginTypes } from "./plugins/types"
|
2023-06-02 00:35:31 +03:00
|
|
|
import { Theme } from "./theme"
|
2023-05-30 18:02:20 +03:00
|
|
|
|
2023-07-02 23:08:29 +03:00
|
|
|
export type Analytics = null
|
|
|
|
| {
|
|
|
|
provider: 'plausible'
|
|
|
|
}
|
|
|
|
| {
|
|
|
|
provider: 'google',
|
|
|
|
tagId: string
|
|
|
|
}
|
|
|
|
|
2023-06-02 00:35:31 +03:00
|
|
|
export interface GlobalConfiguration {
|
2023-07-01 23:35:27 +03:00
|
|
|
pageTitle: string,
|
2023-06-02 00:35:31 +03:00
|
|
|
/** Whether to enable single-page-app style rendering. this prevents flashes of unstyled content and improves smoothness of Quartz */
|
|
|
|
enableSPA: boolean,
|
2023-07-01 10:03:01 +03:00
|
|
|
/** Whether to display Wikipedia-style popovers when hovering over links */
|
|
|
|
enablePopovers: boolean,
|
2023-07-02 23:08:29 +03:00
|
|
|
/** Analytics mode */
|
|
|
|
analytics: Analytics
|
2023-06-02 00:35:31 +03:00
|
|
|
/** Glob patterns to not search */
|
|
|
|
ignorePatterns: string[],
|
2023-07-01 23:35:27 +03:00
|
|
|
/** Base URL to use for CNAME files, sitemaps, and RSS feeds that require an absolute URL.
|
|
|
|
* Quartz will avoid using this as much as possible and use relative URLs most of the time
|
|
|
|
*/
|
|
|
|
canonicalUrl?: string,
|
2023-06-02 00:35:31 +03:00
|
|
|
theme: Theme
|
2023-05-30 18:02:20 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface QuartzConfig {
|
2023-06-02 00:35:31 +03:00
|
|
|
configuration: GlobalConfiguration,
|
2023-05-30 18:02:20 +03:00
|
|
|
plugins: PluginTypes,
|
|
|
|
}
|
2023-07-01 10:03:01 +03: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">
|