quartz-research-note/quartz/cfg.ts

68 lines
2.1 KiB
TypeScript
Raw Normal View History

2023-08-24 15:56:40 +00:00
import { ValidDateType } from "./components/Date"
2023-07-01 07:03:01 +00:00
import { QuartzComponent } from "./components/types"
2024-02-05 10:45:36 +00:00
import { ValidLocale } from "./i18n"
import { PluginTypes } from "./plugins/types"
2023-08-17 05:09:11 +00:00
import { Theme } from "./util/theme"
2023-05-30 15:02:20 +00:00
2023-07-10 02:32:24 +00:00
export type Analytics =
| null
2023-07-02 20:08:29 +00:00
| {
2023-07-23 00:27:41 +00:00
provider: "plausible"
2024-01-05 08:29:34 +00:00
host?: string
2023-07-23 00:27:41 +00:00
}
2023-07-02 20:08:29 +00:00
| {
2023-07-23 00:27:41 +00:00
provider: "google"
tagId: string
}
| {
provider: "umami"
websiteId: string
2024-02-05 10:45:36 +00:00
host?: string
}
2023-07-02 20:08:29 +00:00
2023-06-01 21:35:31 +00:00
export interface GlobalConfiguration {
2023-07-23 00:27:41 +00:00
pageTitle: string
2023-06-01 21:35:31 +00:00
/** Whether to enable single-page-app style rendering. this prevents flashes of unstyled content and improves smoothness of Quartz */
2023-07-23 00:27:41 +00:00
enableSPA: boolean
2023-07-01 07:03:01 +00:00
/** Whether to display Wikipedia-style popovers when hovering over links */
2023-07-23 00:27:41 +00:00
enablePopovers: boolean
2023-07-02 20:08:29 +00:00
/** Analytics mode */
2023-07-10 02:32:24 +00:00
analytics: Analytics
2023-06-01 21:35:31 +00:00
/** Glob patterns to not search */
2023-07-23 00:27:41 +00:00
ignorePatterns: string[]
2023-08-24 15:56:40 +00:00
/** Whether to use created, modified, or published as the default type of date */
defaultDateType: ValidDateType
2023-07-01 20:35:27 +00:00
/** Base URL to use for CNAME files, sitemaps, and RSS feeds that require an absolute URL.
2023-07-23 00:27:41 +00:00
* Quartz will avoid using this as much as possible and use relative URLs most of the time
*/
baseUrl?: string
2023-06-01 21:35:31 +00:00
theme: Theme
2024-02-05 10:45:36 +00:00
/**
* Allow to translate the date in the language of your choice.
* Also used for UI translation (default: en-US)
* Need to be formated following BCP 47: https://en.wikipedia.org/wiki/IETF_language_tag
* The first part is the language (en) and the second part is the script/region (US)
* Language Codes: https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
* Region Codes: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
*/
locale: ValidLocale
2023-05-30 15:02:20 +00:00
}
export interface QuartzConfig {
2023-07-23 00:27:41 +00:00
configuration: GlobalConfiguration
plugins: PluginTypes
2023-05-30 15:02:20 +00:00
}
2023-07-01 07:03:01 +00:00
export interface FullPageLayout {
head: QuartzComponent
2023-07-23 00:27:41 +00:00
header: QuartzComponent[]
beforeBody: QuartzComponent[]
pageBody: QuartzComponent
left: QuartzComponent[]
right: QuartzComponent[]
footer: QuartzComponent
2023-07-01 07:03:01 +00:00
}
export type PageLayout = Pick<FullPageLayout, "beforeBody" | "left" | "right">
export type SharedLayout = Pick<FullPageLayout, "head" | "header" | "footer">