|
| 1 | +#图书馆 |
| 2 | + |
| 3 | +Quartz 被设计为高度可配置的。即便你不懂代码,大部分你需要的配置项都可以在 `quartz.config.ts` 和 `quartz.layout.ts` 里面找到 |
| 4 | + |
| 5 | +> [!tip] |
| 6 | +> 使用 VSCode 或者其他有 Typescript 语法支持的文本编辑器,这样在你写错的时候就能得到警告。 |
| 7 | +
|
| 8 | +配置 Quartz 可以分解为两部分: |
| 9 | +`quartz.config.ts` |
| 10 | +``` |
| 11 | +const config: QuartzConfig = { |
| 12 | + configuration: { ... }, |
| 13 | + plugins: { ... }, |
| 14 | +} |
| 15 | +``` |
| 16 | + |
| 17 | +## Gerneral 配置 |
| 18 | +这部分配置通常能影响整个站点。下面的列表列出了你可以配置的项目。 |
| 19 | + |
| 20 | +> [!warning] |
| 21 | +> 下面是机翻,我还没校对。 |
| 22 | +
|
| 23 | +**pageTitle**: 网站的标题。此标题也会在生成 RSS 订阅源时使用。 |
| 24 | + |
| 25 | +**pageTitleSuffix**: 添加到页面标题末尾的字符串。此设置仅适用于浏览器标签页标题,不会影响页面顶部显示的标题。 |
| 26 | + |
| 27 | +**enableSPA**: 是否启用单页应用(SPA)路由功能。 |
| 28 | + |
| 29 | +**enablePopovers**: 是否启用弹出式预览功能。 |
| 30 | + |
| 31 | +**analytics**: 网站使用的分析工具。可选值如下: |
| 32 | + |
| 33 | +- `null`:不使用分析工具。 |
| 34 | + |
| 35 | +- `{ provider: 'google', tagId: '<your-google-tag>' }`:使用 Google Analytics。 |
| 36 | + |
| 37 | +- `{ provider: 'plausible' }`(托管版)或 `{ provider: 'plausible', host: '<your-plausible-host>' }`(自托管版):使用 Plausible。 |
| 38 | + |
| 39 | +- `{ provider: 'umami', host: '<your-umami-host>', websiteId: '<your-umami-website-id>' }`:使用 Umami。 |
| 40 | + |
| 41 | +- `{ provider: 'goatcounter', websiteId: 'my-goatcounter-id' }`(托管版)或 `{ provider: 'goatcounter', websiteId: 'my-goatcounter-id', host: 'my-goatcounter-domain.com', scriptSrc: '<url id="cuulbles1rhfve4f810g" type="url" status="failed" title="" wc="0">https://my-url.to/counter.js</url>' }`(自托管版):使用 GoatCounter。 |
| 42 | + |
| 43 | +- `{ provider: 'posthog', apiKey: '<your-posthog-project-apiKey>', host: '<your-posthog-host>' }`:使用 Posthog。 |
| 44 | + |
| 45 | +- `{ provider: 'tinylytics', siteId: '<your-site-id>' }`:使用 Tinylytics。 |
| 46 | + |
| 47 | +- `{ provider: 'cabin' }` 或 `{ provider: 'cabin', host: '<url id="cuulbles1rhfve4f8110" type="url" status="failed" title="" wc="0">https://cabin.example.com</url>' }`(自定义域名):使用 Cabin。 |
| 48 | + |
| 49 | +- `{ provider: 'clarity', projectId: '<your-clarity-id-code>' }`:使用 Microsoft Clarity。项目 ID 可在概览页面顶部找到。 |
| 50 | + |
| 51 | + |
| 52 | +**locale**: 用于国际化(i18n)和日期格式化。 |
| 53 | + |
| 54 | +**baseUrl**: 用于站点地图和 RSS 订阅源的绝对 URL,以确定网站的“主页”所在位置。这通常是网站的部署地址(例如,此网站的地址是 quartz.jzhao.xyz)。不要包含协议(即 https://)或任何前导或尾随斜杠。如果在没有自定义域名的情况下将网站托管在 GitHub Pages 上,也应包含子路径。例如,如果我的仓库是 jackyzha0/quartz,GitHub Pages 会部署到 <url id="cuulbles1rhfve4f811g" type="url" status="failed" title="" wc="0">[https://jackyzha0.github.io/quartz](https://jackyzha0.github.io/quartz)</url>,baseUrl 应为 jackyzha0.github.io/quartz。请注意,Quartz 4 将尽可能避免使用此设置,并尽可能使用相对 URL,以确保无论您最终将网站部署到何处,网站都能正常运行。 |
| 55 | + |
| 56 | +**ignorePatterns**: 一个包含 glob 模式的列表,Quartz 会忽略这些模式,并在内容文件夹中搜索文件时跳过它们。更多详情请参阅私有页面。 |
| 57 | + |
| 58 | +**defaultDateType**: 决定在页面和页面列表中默认显示创建日期、修改日期还是发布日期。 |
| 59 | + |
| 60 | +**theme**: 配置网站的外观。 |
| 61 | + |
| 62 | +**cdnCaching**: 如果为 `true`(默认值),则使用 Google CDN 缓存字体。这通常会更快。如果希望 Quartz 下载字体以实现自包含,可以将其禁用(设置为 `false`)。 |
| 63 | + |
| 64 | +**typography**: 字体设置。可以使用 Google Fonts 上的任何字体。 |
| 65 | + |
| 66 | +- **header**: 用于标题的字体。 |
| 67 | + |
| 68 | +- **code**: 用于内联代码和代码块的字体。 |
| 69 | + |
| 70 | +- **body**: 用于正文的字体。 |
| 71 | + |
| 72 | + |
| 73 | +**colors**: 控制网站的主题配色。 |
| 74 | + |
| 75 | +- **light**: 页面背景色。 |
| 76 | + |
| 77 | +- **lightgray**: 边框颜色。 |
| 78 | + |
| 79 | +- **gray**: 图表链接、较重边框的颜色。 |
| 80 | + |
| 81 | +- **darkgray**: 正文文字颜色。 |
| 82 | + |
| 83 | +- **dark**: 标题文字和图标颜色。 |
| 84 | + |
| 85 | +- **secondary**: 链接颜色、当前图表节点的颜色。 |
| 86 | + |
| 87 | +- **tertiary**: 鼠标悬停状态和已访问图表节点的颜色。 |
| 88 | + |
| 89 | +- **highlight**: 内部链接背景、高亮文本、高亮代码行的颜色。 |
| 90 | + |
| 91 | + |
| 92 | +**textHighlight**: Markdown 中高亮文本的背景色。 |
0 commit comments