很多人积累了大量 Markdown 笔记、Obsidian 库或「数字花园」,却始终没把它们变成能分享的网站——要么卡在搭建环境的复杂度,要么被某个笔记平台的封闭格式拴住,想导出成独立站点要折腾很久。

Quartz 想让这件事变得「免费且顺手」。它是一个静态站点生成器,把你已有的 Markdown 内容(包括双链、标签、图谱)转换成功能完整的网站。你继续用熟悉的编辑器写笔记,Quartz 负责把整套知识库发布出去,静态产物可以托管到任意支持静态文件的地方。

项目基本信息

信息项详情
项目名称Quartz
GitHub地址https://github.com/jackyzha0/quartz
项目描述将 Markdown / Obsidian 笔记一键生成功能完整静态网站的免费工具集
作者jackyzha0
开源协议MIT License
开源状态公开
LanguagesTypeScript
支持平台Windows / macOS / Linux
最后更新2026-10-04

一、项目介绍

Quartz 是一套帮助你把「数字花园」和笔记免费发布成网站的工具。它从设计上贴合 Obsidian 用户的工作流:双链、标签、反向链接、图谱等笔记特性在生成的网站里依然可用,而不是被扁平化成普通文章。

它当前主版本为 v5,核心体验是「初始化一次、写笔记、一条命令发布」。生成的是纯静态网站,不依赖数据库,可直接托管在 GitHub Pages、Cloudflare Pages、Vercel 等任意静态平台,方便个人知识库对外分享或长期归档。

二、核心优势

  • 笔记原生:保留 Obsidian 双链、反向链接、标签与图谱等结构,不只是转成文章。
  • 零运行时依赖:输出纯静态文件,托管简单、加载快、易长期保存。
  • 免费开源:MIT 协议,可自行修改主题与管线。
  • 一条命令发布:初始化后写作与同步高度自动化,降低维护成本。
  • 可定制:基于 TypeScript 构建,主题与内容处理管线可扩展。

三、适用场景

  • 个人知识库 / 数字花园对外分享。
  • Obsidian 用户想把笔记库变成可访问的网站。
  • 技术博客:用 Markdown 写作、静态托管。
  • 长期归档:不依赖平台、产物自持。

四、安装教程

需要 Node.js 环境。新建项目并初始化:

npm create quartz@latest

进入目录后,把你的 Markdown / Obsidian 笔记放入 content 文件夹,然后构建:

npx quartz build

本地预览与同步到 GitHub Pages:

npx quartz sync

常见报错与处理:

npm error code EBADENGINE

Node 版本过低,升级到 Quartz 要求的 LTS 版本后重试。

content folder not found

未将笔记放入 content 目录,按初始化后的目录结构放置 Markdown 文件再 build。

五、使用示例

初始化后目录里放入一篇笔记 content/hello.md:

---
title: 你好,Quartz
---
这是我的第一篇静态站点笔记,支持 **双链** 与标签 #demo。

执行构建与本地查看:

npx quartz build --serve

真实输出:本地启动一个站点,浏览器打开后看到渲染好的页面,笔记里的双链可点击跳转、标签可聚合,整体就是一座可分享的静态知识花园。

六、常见问题

  • 支持 Obsidian 双链吗? 支持,反向链接与图谱在生成站点中保留。
  • 托管到哪里? 任意静态平台,如 GitHub Pages、Cloudflare Pages、Vercel。
  • 需要数据库吗? 不需要,产物是纯静态文件。
  • 协议是什么? MIT License,可自由用于个人与商业场景。

七、总结

Quartz 把「写笔记」和「发网站」之间的鸿沟填平了:你继续在 Obsidian 或任意 Markdown 编辑器里写作,Quartz 负责把整套知识库变成可托管、可分享的静态站点。对不想被平台绑定、又想要一个漂亮知识花园的人来说,它是低成本、高自由度的理想选择。