Quartz 内置功能全景从内容、导航到发布部署的完整功能清单与配置指南【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartzQuartz 是一款开箱即用batteries-included的静态站点生成器将 Markdown 内容转化为功能完整的网站。本指南以官方「Feature List」为核心逐一梳理 Quartz 内置的四大类功能——内容、导航与发现、外观与阅读、发布与部署并结合仓库中的默认配置quartz.config.default.yaml与源码quartz/plugins/config.ts说明每项功能背后的插件机制帮助你在搭建数字花园、知识库或博客时快速定位所需能力并完成开关与定制。阅读完本文你将掌握Quartz 内置功能的全貌与分类、每项功能的开启位置与关键配置项、功能背后的插件体系transformer / filter / emitter / pageType如何工作以及如何通过quartz.config.yaml增删、排序、定制插件。功能背后的统一架构插件驱动的特性系统Quartz 内置的绝大多数功能并非硬编码在渲染流程中而是以**插件plugins**的形式存在可以在quartz.config.yaml中统一配置、启用或禁用。这一点在官方功能清单中开宗明义Quartz comes with a wide variety of features out of the box. Most features are powered by plugins that can be configured, enabled, or disabled viaquartz.config.yaml.从源码结构看quartz/plugins/config.ts 将插件划分为四类插件类别作用典型功能Transformers转换器对每个文件内容进行映射式变换解析 frontmatter、生成描述、Obsidian 风格 Markdown、语法高亮、LaTeXFilters过滤器对内容进行筛选过滤草稿RemoveDrafts、显式发布ExplicitPublishEmitters发射器对全部内容做归约聚合输出生成 RSS、站点地图、标签页、搜索索引Page Types页面类型定义不同页面如何渲染内容页、文件夹页、标签页、Canvas 页、Bases 页order字段控制同类插件之间的执行顺序数值越小越先执行。例如obsidian-flavored-markdownorder 30必须排在syntax-highlightingorder 20之后、ox-hugoorder 25之后否则 callout、Mermaid 等语法可能无法被正确解析详见 callouts 与 Mermaid diagrams 中的警告。Quartz 内容处理流水线示意图如下它直观展示了 Markdown 源文件如何经过插件逐级变换最终输出为静态站点Quartz 内容变换流水线Markdown 经插件逐级转换并输出为静态站点内容类功能Content Features内容类功能聚焦「写与渲染」是知识库的核心生产力所在。Obsidian 兼容Quartz 最初就是为了将 Obsidian vault 发布为网站而设计因此与 Obsidian 的无缝互操作是它的看家本领。默认随附的ObsidianFlavoredMarkdown转换插件支持 Obsidian 风格 Markdown 的绝大部分特性详见 Obsidian compatibilityWikilinks[[Page]]、[[Page|别名]]、[[Page#Heading]]、[[Page#^block-id]]以及![[Page]]嵌入/转clusiontransclude高亮文本注释%%注释内容%%支持多行渲染时被剥离标签#tag、#nested/tag自动解析并链接到标签页纯数字标签如#123会被忽略与 Obsidian 行为一致任务列表与自定义任务字符在enableCheckbox: true时支持[?]、[!]、[]、[/]、[-]、[s]等社区流行字符并以data-task属性保留在 DOM 中供 CSS 定制YouTube / Tweet / 视频嵌入使用标准图片语法即可嵌入块引用block references^block-id定位obsidian://链接自动附加obsidian-uriCSS 类与data-obsidian-uri属性以便单独样式化。该功能由三个插件协同提供ObsidianFlavoredMarkdown语法支持、Frontmatterfrontmatter 解析字段与 Obsidian 一致与 CrawlLinks链接解析策略定制。WikilinksWikilinks 由CrawlLinks插件解析详见 wikilinks。匹配不区分大小写与 Obsidian 保持一致[[My Note]]、[[my note]]、[[MY NOTE]]都解析到同一文件且生成 URL 会小写化如my-note。支持锚点与块引用[[Path to file]]→ 指向Path to file.md的链接[[Path to file | 自定义文本]]→ 带别名文本的链接[[Path to file#Anchor]]→ 指向锚点的链接[[Path to file#^block-ref]]→ 指向指定块的链接![[Path to image|100x145]]→ 按 100px × 145px 尺寸嵌入图片![[Path to file#Anchor]]→ 嵌入标题下的所有内容。CalloutsQuartz 完整支持 Obsidian 的 Admonition 风格 callout 语法详见 callouts内置 12 种类型及其别名note、abstract/summary/tldr、info、todo、tip/hint/important、success/check/done、question/help/faq、warning/attention/caution、failure/missing/fail、danger/error、bug、example、quote/cite。还支持折叠变体 [!warning]-默认折叠、 [!tip]默认展开以及多层嵌套。定制方式修改 quartz/styles/callouts.scss 调整图标在 quartz/styles/custom.scss 中按data-callout属性为自定义类型添加颜色与 SVG 图标注意 SVG 需 URL 编码。LaTeX 数学公式Quartz 默认使用 KaTeX 在构建时排版行内与块级数学公式详见 Latex块级公式以$$分隔注意$$必须独占新行行内公式以单个$分隔如$e^{i\pi} -1$转义段落中出现多个$时用\$转义如I have \$1 and you have \$2mhchem使用社区 Latex 插件时可在源码入口import katex/contrib/mhchem引入化学式支持。对应插件为 Latex默认配置使用renderEngine: katex。Mermaid 图表在笔记中以ts titlequartz/path.ts行高亮ts {2-3,6}词高亮js /useState/行内高亮[1, 2, 3]{:js}行号默认自动显示showLineNumbers{20}可指定起始行号。注意大量代码块会拖慢构建速度。对应插件为 SyntaxHighlighting默认主题github-light/github-dark。OxHugo 兼容面向 Emacs org-mode 生态ox-hugo 将org-roam文件导出为 Hugo 风格 MarkdownOxHugoFlavoredMarkdown插件将其转换为 Quartz 可识别的标准 Markdown详见 OxHugo compatibility。配置时需注意ox-hugo的 order 必须小于obsidian-flavored-markdown先执行并使用note-properties插件配合delimiters: 、language: toml解析 TOML frontmatter。org-roam 源文件本身不被 Quartz 直接读取需要先用外部工具导出为 Markdown。Roam Research 兼容RoamFlavoredMarkdown插件将 Roam Research 的特殊语法如{{[[components]]}}转换为常规 Markdown详见 Roam Research compatibility。同样要求roam的 order如 25低于obsidian-flavored-markdown30。Citations 学术引用支持学术引用citations能力对应 Citations 插件默认在配置中处于enabled: false按需开启。Canvas 与 BasesCanvas将 Obsidian Canvas 文件渲染为交互式页面CanvasPage默认开启Bases为笔记提供数据库式视图——表格、卡片、画廊等BasesPage默认开启对应页面类型bases。导航与发现类功能Navigation Discovery这类功能解决「读者如何在站点中找到内容、建立联系」。全文搜索跨全部笔记全文检索由 Search 插件驱动默认开启并置于左侧工具栏layout.position: left, group: toolbar图视图交互式笔记连接关系图由 Graph 插件驱动默认开启右侧边栏反向链接展示哪些笔记链接到当前页面Backlinks 默认开启右侧资源管理器文件树侧边栏Explorer 默认开启左侧面包屑导航路径追踪Breadcrumbs 默认开启condition: not-index首页不显示目录页面级 Table of ContentsTableOfContents 默认开启右侧文件夹与标签列表按文件夹或标签浏览笔记由 FolderPage 与 TagPage 默认开启支持最近笔记展示最近修改的笔记RecentNotes 默认关闭按需开启悬浮预览悬停内部链接即弹出预览由全局配置enablePopovers: truequartz.config.default.yaml控制堆叠页面Andy Matuschak 风格的滑动堆叠面板用于追溯笔记间的引用脉络StackedPages 默认关闭加密页面基于客户端加密对单页进行密码保护EncryptedPages 默认开启默认参数iterations: 600000、passwordField: password并输出static/encryptedContentIndex.json。外观与阅读类功能Appearance Reading深色模式明暗主题切换Darkmode 默认开启左侧工具栏配色在configuration.theme.colors.lightMode/darkMode中分别定义阅读模式去干扰的沉浸式阅读ReaderMode 默认开启工具栏文件夹页与标签页在默认配置中排除了reader-mode布局评论接入 Giscus、Utterances 等评论服务Comments 默认关闭配置中预置provider: giscus示例社交分享图自动生成 Open Graph 分享图片CustomOgImagesog-image默认开启。发布与部署类功能Publishing DeploymentRSS 订阅内容联合分发由 ContentIndex 插件统一生成options.enableRSS: true时开启站点地图enableSiteMap同源管理页面标题同时用于 RSS 生成私有页面通过全局ignorePatternsglob 模式如private、templates、.obsidian控制哪些内容不发布配合 UnlistedPages默认开启与 ExplicitPublish默认关闭实现精细的发布控制详见 private pagesSPA 路由单页应用式导航由全局enableSPA: true开启详见 SPA RoutingDocker 支持仓库根目录提供 Dockerfile可用容器构建与部署i18n 国际化30 语言环境支持由全局locale字段指定语言包位于 quartz/i18n/locales含zh-CN、zh-TW、ja-JP等 30 余个详见 i18n。默认开启清单开箱即用与按需扩展参考仓库的 quartz.config.default.yamlQuartz 5 默认启用的核心插件如下其余功能按需在plugins列表中追加功能领域默认开启默认关闭按需开启内容Obsidian Markdown、GFM、LaTeX(KaTeX)、语法高亮、目录、描述生成、Canvas 页、Bases 页Citations、硬换行、OxHugo、Roam、TagList导航搜索、图视图、反向链接、资源管理器、面包屑、文件夹页、标签页最近笔记、堆叠页面外观深色模式、阅读模式、NoteProperties、文章标题、内容元信息评论giscus 示例、TagList发布RSS站点地图ContentIndex、OG 图、Favicon、CNAME、未列出页、加密页、别名重定向显式发布、StackedPages启用与扩展功能的实操方式修改 YAML 配置编辑 quartz.config.default.yaml部署时通常复制为quartz.config.yaml每个插件条目包含source来源、enabled开关、order同类内执行顺序、options参数与layout布局位置例如plugins: - source: quartz-community/latex enabled: true options: renderEngine: katex order: 80 - source: quartz-community/recent-notes enabled: true安装社区插件社区插件通过github:org/repo形式引用使用 CLI 安装npx quartz plugin add github:quartz-community/explorer npx quartz plugin install --from-config # 安装配置中所有未安装插件克隆项目/CI 场景 npx quartz plugin prune # 移除配置中已不存在的插件--dry-run可预览变更支持subdirmonorepo 子目录、ref分支/tag 锁定与name本地目录名覆盖等高级 source 形式。TS 覆盖模式当需要 JS 回调自定义排序、过滤、映射函数或更细粒度的字体控制时可在 quartz.ts 中通过loadQuartzConfig()覆盖配置——TS 选项与 YAML 合并且优先级更高插件覆盖必须写在loadQuartzConfig()调用之前详见 configuration。结语Quartz 的功能广度覆盖了从 Obsidian 兼容写作、知识网络可视化到 RSS、SPA、Docker 部署与 30 语言国际化的完整链路且所有能力都收敛到「插件 单一 YAML 配置」的简单心智模型之下。对照本清单你可以快速确定某项需求是否开箱可用、对应哪个插件、在哪里调整参数需要更深度的定制时可继续阅读 making plugins 了解如何编写自有插件或查阅 tags/plugin 获取全部插件清单与配置选项。【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartz创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Quartz 内置功能全景：从内容、导航到发布部署的完整功能清单与配置指南
Quartz 内置功能全景从内容、导航到发布部署的完整功能清单与配置指南【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartzQuartz 是一款开箱即用batteries-included的静态站点生成器将 Markdown 内容转化为功能完整的网站。本指南以官方「Feature List」为核心逐一梳理 Quartz 内置的四大类功能——内容、导航与发现、外观与阅读、发布与部署并结合仓库中的默认配置quartz.config.default.yaml与源码quartz/plugins/config.ts说明每项功能背后的插件机制帮助你在搭建数字花园、知识库或博客时快速定位所需能力并完成开关与定制。阅读完本文你将掌握Quartz 内置功能的全貌与分类、每项功能的开启位置与关键配置项、功能背后的插件体系transformer / filter / emitter / pageType如何工作以及如何通过quartz.config.yaml增删、排序、定制插件。功能背后的统一架构插件驱动的特性系统Quartz 内置的绝大多数功能并非硬编码在渲染流程中而是以**插件plugins**的形式存在可以在quartz.config.yaml中统一配置、启用或禁用。这一点在官方功能清单中开宗明义Quartz comes with a wide variety of features out of the box. Most features are powered by plugins that can be configured, enabled, or disabled viaquartz.config.yaml.从源码结构看quartz/plugins/config.ts 将插件划分为四类插件类别作用典型功能Transformers转换器对每个文件内容进行映射式变换解析 frontmatter、生成描述、Obsidian 风格 Markdown、语法高亮、LaTeXFilters过滤器对内容进行筛选过滤草稿RemoveDrafts、显式发布ExplicitPublishEmitters发射器对全部内容做归约聚合输出生成 RSS、站点地图、标签页、搜索索引Page Types页面类型定义不同页面如何渲染内容页、文件夹页、标签页、Canvas 页、Bases 页order字段控制同类插件之间的执行顺序数值越小越先执行。例如obsidian-flavored-markdownorder 30必须排在syntax-highlightingorder 20之后、ox-hugoorder 25之后否则 callout、Mermaid 等语法可能无法被正确解析详见 callouts 与 Mermaid diagrams 中的警告。Quartz 内容处理流水线示意图如下它直观展示了 Markdown 源文件如何经过插件逐级变换最终输出为静态站点Quartz 内容变换流水线Markdown 经插件逐级转换并输出为静态站点内容类功能Content Features内容类功能聚焦「写与渲染」是知识库的核心生产力所在。Obsidian 兼容Quartz 最初就是为了将 Obsidian vault 发布为网站而设计因此与 Obsidian 的无缝互操作是它的看家本领。默认随附的ObsidianFlavoredMarkdown转换插件支持 Obsidian 风格 Markdown 的绝大部分特性详见 Obsidian compatibilityWikilinks[[Page]]、[[Page|别名]]、[[Page#Heading]]、[[Page#^block-id]]以及![[Page]]嵌入/转clusiontransclude高亮文本注释%%注释内容%%支持多行渲染时被剥离标签#tag、#nested/tag自动解析并链接到标签页纯数字标签如#123会被忽略与 Obsidian 行为一致任务列表与自定义任务字符在enableCheckbox: true时支持[?]、[!]、[]、[/]、[-]、[s]等社区流行字符并以data-task属性保留在 DOM 中供 CSS 定制YouTube / Tweet / 视频嵌入使用标准图片语法即可嵌入块引用block references^block-id定位obsidian://链接自动附加obsidian-uriCSS 类与data-obsidian-uri属性以便单独样式化。该功能由三个插件协同提供ObsidianFlavoredMarkdown语法支持、Frontmatterfrontmatter 解析字段与 Obsidian 一致与 CrawlLinks链接解析策略定制。WikilinksWikilinks 由CrawlLinks插件解析详见 wikilinks。匹配不区分大小写与 Obsidian 保持一致[[My Note]]、[[my note]]、[[MY NOTE]]都解析到同一文件且生成 URL 会小写化如my-note。支持锚点与块引用[[Path to file]]→ 指向Path to file.md的链接[[Path to file | 自定义文本]]→ 带别名文本的链接[[Path to file#Anchor]]→ 指向锚点的链接[[Path to file#^block-ref]]→ 指向指定块的链接![[Path to image|100x145]]→ 按 100px × 145px 尺寸嵌入图片![[Path to file#Anchor]]→ 嵌入标题下的所有内容。CalloutsQuartz 完整支持 Obsidian 的 Admonition 风格 callout 语法详见 callouts内置 12 种类型及其别名note、abstract/summary/tldr、info、todo、tip/hint/important、success/check/done、question/help/faq、warning/attention/caution、failure/missing/fail、danger/error、bug、example、quote/cite。还支持折叠变体 [!warning]-默认折叠、 [!tip]默认展开以及多层嵌套。定制方式修改 quartz/styles/callouts.scss 调整图标在 quartz/styles/custom.scss 中按data-callout属性为自定义类型添加颜色与 SVG 图标注意 SVG 需 URL 编码。LaTeX 数学公式Quartz 默认使用 KaTeX 在构建时排版行内与块级数学公式详见 Latex块级公式以$$分隔注意$$必须独占新行行内公式以单个$分隔如$e^{i\pi} -1$转义段落中出现多个$时用\$转义如I have \$1 and you have \$2mhchem使用社区 Latex 插件时可在源码入口import katex/contrib/mhchem引入化学式支持。对应插件为 Latex默认配置使用renderEngine: katex。Mermaid 图表在笔记中以ts titlequartz/path.ts行高亮ts {2-3,6}词高亮js /useState/行内高亮[1, 2, 3]{:js}行号默认自动显示showLineNumbers{20}可指定起始行号。注意大量代码块会拖慢构建速度。对应插件为 SyntaxHighlighting默认主题github-light/github-dark。OxHugo 兼容面向 Emacs org-mode 生态ox-hugo 将org-roam文件导出为 Hugo 风格 MarkdownOxHugoFlavoredMarkdown插件将其转换为 Quartz 可识别的标准 Markdown详见 OxHugo compatibility。配置时需注意ox-hugo的 order 必须小于obsidian-flavored-markdown先执行并使用note-properties插件配合delimiters: 、language: toml解析 TOML frontmatter。org-roam 源文件本身不被 Quartz 直接读取需要先用外部工具导出为 Markdown。Roam Research 兼容RoamFlavoredMarkdown插件将 Roam Research 的特殊语法如{{[[components]]}}转换为常规 Markdown详见 Roam Research compatibility。同样要求roam的 order如 25低于obsidian-flavored-markdown30。Citations 学术引用支持学术引用citations能力对应 Citations 插件默认在配置中处于enabled: false按需开启。Canvas 与 BasesCanvas将 Obsidian Canvas 文件渲染为交互式页面CanvasPage默认开启Bases为笔记提供数据库式视图——表格、卡片、画廊等BasesPage默认开启对应页面类型bases。导航与发现类功能Navigation Discovery这类功能解决「读者如何在站点中找到内容、建立联系」。全文搜索跨全部笔记全文检索由 Search 插件驱动默认开启并置于左侧工具栏layout.position: left, group: toolbar图视图交互式笔记连接关系图由 Graph 插件驱动默认开启右侧边栏反向链接展示哪些笔记链接到当前页面Backlinks 默认开启右侧资源管理器文件树侧边栏Explorer 默认开启左侧面包屑导航路径追踪Breadcrumbs 默认开启condition: not-index首页不显示目录页面级 Table of ContentsTableOfContents 默认开启右侧文件夹与标签列表按文件夹或标签浏览笔记由 FolderPage 与 TagPage 默认开启支持最近笔记展示最近修改的笔记RecentNotes 默认关闭按需开启悬浮预览悬停内部链接即弹出预览由全局配置enablePopovers: truequartz.config.default.yaml控制堆叠页面Andy Matuschak 风格的滑动堆叠面板用于追溯笔记间的引用脉络StackedPages 默认关闭加密页面基于客户端加密对单页进行密码保护EncryptedPages 默认开启默认参数iterations: 600000、passwordField: password并输出static/encryptedContentIndex.json。外观与阅读类功能Appearance Reading深色模式明暗主题切换Darkmode 默认开启左侧工具栏配色在configuration.theme.colors.lightMode/darkMode中分别定义阅读模式去干扰的沉浸式阅读ReaderMode 默认开启工具栏文件夹页与标签页在默认配置中排除了reader-mode布局评论接入 Giscus、Utterances 等评论服务Comments 默认关闭配置中预置provider: giscus示例社交分享图自动生成 Open Graph 分享图片CustomOgImagesog-image默认开启。发布与部署类功能Publishing DeploymentRSS 订阅内容联合分发由 ContentIndex 插件统一生成options.enableRSS: true时开启站点地图enableSiteMap同源管理页面标题同时用于 RSS 生成私有页面通过全局ignorePatternsglob 模式如private、templates、.obsidian控制哪些内容不发布配合 UnlistedPages默认开启与 ExplicitPublish默认关闭实现精细的发布控制详见 private pagesSPA 路由单页应用式导航由全局enableSPA: true开启详见 SPA RoutingDocker 支持仓库根目录提供 Dockerfile可用容器构建与部署i18n 国际化30 语言环境支持由全局locale字段指定语言包位于 quartz/i18n/locales含zh-CN、zh-TW、ja-JP等 30 余个详见 i18n。默认开启清单开箱即用与按需扩展参考仓库的 quartz.config.default.yamlQuartz 5 默认启用的核心插件如下其余功能按需在plugins列表中追加功能领域默认开启默认关闭按需开启内容Obsidian Markdown、GFM、LaTeX(KaTeX)、语法高亮、目录、描述生成、Canvas 页、Bases 页Citations、硬换行、OxHugo、Roam、TagList导航搜索、图视图、反向链接、资源管理器、面包屑、文件夹页、标签页最近笔记、堆叠页面外观深色模式、阅读模式、NoteProperties、文章标题、内容元信息评论giscus 示例、TagList发布RSS站点地图ContentIndex、OG 图、Favicon、CNAME、未列出页、加密页、别名重定向显式发布、StackedPages启用与扩展功能的实操方式修改 YAML 配置编辑 quartz.config.default.yaml部署时通常复制为quartz.config.yaml每个插件条目包含source来源、enabled开关、order同类内执行顺序、options参数与layout布局位置例如plugins: - source: quartz-community/latex enabled: true options: renderEngine: katex order: 80 - source: quartz-community/recent-notes enabled: true安装社区插件社区插件通过github:org/repo形式引用使用 CLI 安装npx quartz plugin add github:quartz-community/explorer npx quartz plugin install --from-config # 安装配置中所有未安装插件克隆项目/CI 场景 npx quartz plugin prune # 移除配置中已不存在的插件--dry-run可预览变更支持subdirmonorepo 子目录、ref分支/tag 锁定与name本地目录名覆盖等高级 source 形式。TS 覆盖模式当需要 JS 回调自定义排序、过滤、映射函数或更细粒度的字体控制时可在 quartz.ts 中通过loadQuartzConfig()覆盖配置——TS 选项与 YAML 合并且优先级更高插件覆盖必须写在loadQuartzConfig()调用之前详见 configuration。结语Quartz 的功能广度覆盖了从 Obsidian 兼容写作、知识网络可视化到 RSS、SPA、Docker 部署与 30 语言国际化的完整链路且所有能力都收敛到「插件 单一 YAML 配置」的简单心智模型之下。对照本清单你可以快速确定某项需求是否开箱可用、对应哪个插件、在哪里调整参数需要更深度的定制时可继续阅读 making plugins 了解如何编写自有插件或查阅 tags/plugin 获取全部插件清单与配置选项。【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartz创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考