keroosha.cybergulag.today/quartz/cfg.ts

57 lines
1.6 KiB
TypeScript
Raw Normal View History

2023-08-24 18:56:40 +03:00
import { ValidDateType } from "./components/Date"
2023-07-01 10:03:01 +03:00
import { QuartzComponent } from "./components/types"
import { PluginTypes } from "./plugins/types"
2023-08-17 08:09:11 +03:00
import { Theme } from "./util/theme"
2023-05-30 18:02:20 +03:00
2023-07-10 05:32:24 +03:00
export type Analytics =
| null
2023-07-02 23:08:29 +03:00
| {
2023-07-23 03:27:41 +03:00
provider: "plausible"
}
2023-07-02 23:08:29 +03:00
| {
2023-07-23 03:27:41 +03:00
provider: "google"
tagId: string
}
| {
provider: "umami"
websiteId: string
}
2023-07-02 23:08:29 +03:00
2023-06-02 00:35:31 +03:00
export interface GlobalConfiguration {
2023-07-23 03:27:41 +03:00
pageTitle: string
feat: Making Quartz available offline by making it a PWA (#465) * Adding PWA and chaching for offline aviability * renamed workbox config to fit Quartz' scheme * Documenting new configuration * Added missig umami documentation * Fixed formatting so the build passes, thank you prettier :) * specified caching strategies to improve performance * formatting... * fixing "404 manifest.json not found" on subdirectories by adding a / to manifestpath * turning it into a plugin * Removed Workbox-cli and updated @types/node * Added Serviceworkercode to offline.ts * formatting * Removing workbox from docs * applied suggestions * Removed path.join for sw path Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * Removed path.join for manifest path Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * Removing path module import * Added absolute path to manifests start_url and manifest "import" using baseUrl * Adding protocol to baseurl Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * Adding protocol to start_url too then * formatting... * Adding fallback page * Documenting offline plugin * formatting... * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * formatting... * Fixing manifest path, all these nits hiding the actual issues .-. * Offline fallback page through plugins, most things taken from 404 Plugin * adding Offline Plugin to config * formatting... * Turned offline off as default and removed offline.md --------- Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2023-09-20 21:38:13 +03:00
description: 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 */
2023-07-23 03:27:41 +03:00
enableSPA: boolean
2023-07-01 10:03:01 +03:00
/** Whether to display Wikipedia-style popovers when hovering over links */
2023-07-23 03:27:41 +03:00
enablePopovers: boolean
2023-07-02 23:08:29 +03:00
/** Analytics mode */
2023-07-10 05:32:24 +03:00
analytics: Analytics
2023-06-02 00:35:31 +03:00
/** Glob patterns to not search */
2023-07-23 03:27:41 +03:00
ignorePatterns: string[]
2023-08-24 18:56:40 +03:00
/** Whether to use created, modified, or published as the default type of date */
defaultDateType: ValidDateType
2023-07-01 23:35:27 +03:00
/** Base URL to use for CNAME files, sitemaps, and RSS feeds that require an absolute URL.
2023-07-23 03:27:41 +03:00
* Quartz will avoid using this as much as possible and use relative URLs most of the time
*/
baseUrl?: string
2023-06-02 00:35:31 +03:00
theme: Theme
2023-05-30 18:02:20 +03:00
}
export interface QuartzConfig {
2023-07-23 03:27:41 +03:00
configuration: GlobalConfiguration
plugins: PluginTypes
2023-05-30 18:02:20 +03:00
}
2023-07-01 10:03:01 +03:00
export interface FullPageLayout {
head: QuartzComponent
2023-07-23 03:27:41 +03:00
header: QuartzComponent[]
beforeBody: QuartzComponent[]
pageBody: QuartzComponent
left: QuartzComponent[]
right: QuartzComponent[]
footer: QuartzComponent
2023-07-01 10:03:01 +03:00
}
export type PageLayout = Pick<FullPageLayout, "beforeBody" | "left" | "right">
export type SharedLayout = Pick<FullPageLayout, "head" | "header" | "footer">