2023-08-24 22:56:40 +07:00
|
|
|
import { ValidDateType } from "./components/Date"
|
2023-07-01 14:03:01 +07:00
|
|
|
import { QuartzComponent } from "./components/types"
|
2023-06-01 04:01:23 +07:00
|
|
|
import { PluginTypes } from "./plugins/types"
|
2023-08-17 12:09:11 +07:00
|
|
|
import { Theme } from "./util/theme"
|
2023-05-30 22:02:20 +07:00
|
|
|
|
2023-07-10 09:32:24 +07:00
|
|
|
export type Analytics =
|
|
|
|
| null
|
2023-07-03 03:08:29 +07:00
|
|
|
| {
|
2023-07-23 07:27:41 +07:00
|
|
|
provider: "plausible"
|
|
|
|
}
|
2023-07-03 03:08:29 +07:00
|
|
|
| {
|
2023-07-23 07:27:41 +07:00
|
|
|
provider: "google"
|
|
|
|
tagId: string
|
|
|
|
}
|
2023-09-04 11:28:57 +07:00
|
|
|
| {
|
|
|
|
provider: "umami"
|
|
|
|
websiteId: string
|
|
|
|
}
|
2023-07-03 03:08:29 +07:00
|
|
|
|
2023-06-02 04:35:31 +07:00
|
|
|
export interface GlobalConfiguration {
|
2023-07-23 07:27:41 +07:00
|
|
|
pageTitle: string
|
2023-06-02 04:35:31 +07:00
|
|
|
/** Whether to enable single-page-app style rendering. this prevents flashes of unstyled content and improves smoothness of Quartz */
|
2023-07-23 07:27:41 +07:00
|
|
|
enableSPA: boolean
|
2023-07-01 14:03:01 +07:00
|
|
|
/** Whether to display Wikipedia-style popovers when hovering over links */
|
2023-07-23 07:27:41 +07:00
|
|
|
enablePopovers: boolean
|
2023-07-03 03:08:29 +07:00
|
|
|
/** Analytics mode */
|
2023-07-10 09:32:24 +07:00
|
|
|
analytics: Analytics
|
2023-06-02 04:35:31 +07:00
|
|
|
/** Glob patterns to not search */
|
2023-07-23 07:27:41 +07:00
|
|
|
ignorePatterns: string[]
|
2023-08-24 22:56:40 +07:00
|
|
|
/** Whether to use created, modified, or published as the default type of date */
|
|
|
|
defaultDateType: ValidDateType
|
2023-07-02 03:35:27 +07:00
|
|
|
/** Base URL to use for CNAME files, sitemaps, and RSS feeds that require an absolute URL.
|
2023-07-23 07:27:41 +07:00
|
|
|
* Quartz will avoid using this as much as possible and use relative URLs most of the time
|
|
|
|
*/
|
|
|
|
baseUrl?: string
|
2023-06-02 04:35:31 +07:00
|
|
|
theme: Theme
|
2023-05-30 22:02:20 +07:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface QuartzConfig {
|
2023-07-23 07:27:41 +07:00
|
|
|
configuration: GlobalConfiguration
|
|
|
|
plugins: PluginTypes
|
2023-05-30 22:02:20 +07:00
|
|
|
}
|
2023-07-01 14:03:01 +07:00
|
|
|
|
|
|
|
export interface FullPageLayout {
|
|
|
|
head: QuartzComponent
|
2023-07-23 07:27:41 +07:00
|
|
|
header: QuartzComponent[]
|
|
|
|
beforeBody: QuartzComponent[]
|
|
|
|
pageBody: QuartzComponent
|
|
|
|
left: QuartzComponent[]
|
|
|
|
right: QuartzComponent[]
|
|
|
|
footer: QuartzComponent
|
2023-07-01 14:03:01 +07:00
|
|
|
}
|
|
|
|
|
|
|
|
export type PageLayout = Pick<FullPageLayout, "beforeBody" | "left" | "right">
|
2023-08-07 07:09:29 +07:00
|
|
|
export type SharedLayout = Pick<FullPageLayout, "head" | "header" | "footer">
|