Quartz 4 中文文档

Quartz 是一个快速、功能齐全的静态网站生成器，可以将 Markdown 内容转换为功能完善的网站。已有数千名学生、开发者和教师正在使用 Quartz来发布个人笔记、网站和数字花园。

🪴 快速开始

Quartz 需要至少 Node v20 和 npm v9.3.1 才能正常运行。请确保你的电脑已安装这些工具。

然后，在你喜欢的终端中，依次输入以下命令：

git clone https://github.com/jackyzha0/quartz.git
cd quartz
npm i
npx quartz create

这将引导你初始化 Quartz 并添加内容。完成后，你可以了解如何：

1. 在 Quartz 中撰写内容
2. 配置 Quartz 的行为
3. 更改 Quartz 的布局
4. 构建和预览 Quartz
5. 将更改同步到GitHub
6. 在线托管 Quartz

如果你更喜欢视频教程，可以参考 Nicole van der Hoeven 的 Quartz 安装视频指南。

🔧 功能特性

• Obsidian 兼容性、全文搜索、图谱视图、维基链接与转录、反向链接、Latex、语法高亮、弹出预览、Docker 支持、国际化、评论等更多功能，开箱即用
• 配置更改时热重载，内容编辑时增量重建
• 简单的 JSX 布局和页面组件
• 极快的页面加载和极小的包体积
• 通过插件实现完全可定制的解析、过滤和页面生成

完整功能列表请访问功能页面。你可以在理念页面了解这些功能背后的原因，在架构页面了解技术细节。

🚧 故障排查与更新

遇到 Quartz 问题？请尝试使用搜索功能查找你的问题。如果还没有，建议先升级到最新版本，看看是否已修复。

如果问题依然存在，欢迎提交 issue报告 bug，或在我们的 Discord 社区寻求帮助。