欢迎使用 Quartz 4(机翻)

Quartz 是一个开箱即用的快速静态网站生成器，能够将 Markdown 内容转换为功能完备的网站。已有数千名学生、开发者和教师正在使用 Quartz 发布个人笔记、网站和数字花园到互联网。

🪴 开始使用

Quartz 需要至少 Node v20 和 npm v9.3.1 版本支持。请确保您的设备已安装正确版本后再继续操作。

在您选择的终端中，逐行输入以下命令：

# 克隆最新版本
git clone https://github.com/jackyzha0/quartz
cd quartz
 
# 安装依赖
npm install
 
# 启动本地服务器（默认端口：8080）
npm run start

🛠️ 配置

# 编辑配置文件
nvim quartz.config.ts

配置提示

您可以通过修改 quartz.config.ts 文件中的配置项来：

• 设置网站元数据
• 配置搜索引擎优化选项
• 自定义侧边栏和页面布局
• 管理插件和主题设置

📄 内容创作

1. 在 content 目录下创建新的 .md 文件
2. 使用标准 Markdown 语法编写内容
3. 通过双括号语法实现内部链接
4. 添加标签 #tag 进行分类管理

---
title: 我的新页面
tags:
  - 教程
  - 示例
---
 
这是使用 Quartz 创建的[[示例页面]]，展示了 #标签 和 [外部链接](https://quartz.jzhao.xyz) 的使用方法。

🌱 下一步

• 访问 Quartz 官方文档 获取完整指南
• 探索进阶功能配置选项
• 加入我们的 Discord 社区 获取支持
• 在 GitHub 上提交问题 反馈建议

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

本指南将引导您初始化Quartz并添加内容。完成此步骤后，您可以了解如何：

1. 在Quartz中Writing content
2. Configure Quartz的行为
3. 更改Quartz的布局
4. Build and preview并预览Quartz
5. 通过GitHub同步更改
6. 在线Host Quartz

如果您更喜欢视频教程，可以观看Nicole van der Hoeven的 Quartz设置视频指南

🔧 功能

• 开箱即用的Obsidian兼容性、全文搜索、图谱视图、笔记嵌入、双向链接、反向链接、Latex、代码高亮、弹出预览、Docker支持、i18n、评论功能以及更多功能
• 配置和内容的热重载
• 简单的JSX布局和页面组件
• 极速页面加载和极小的包体积
• 通过插件实现完全可定制的解析、过滤和页面生成

完整功能列表请访问功能页面。您可以在设计理念页面了解这些功能背后的设计思路，在架构页面查看技术概览。

🚧 故障排除与更新

使用Quartz遇到问题？请尝试使用搜索功能查找相关问题。如果尚未更新，请upgrade到最新版本的Quartz查看是否解决问题。

如果问题仍未解决，如果您认为发现了错误，欢迎提交issue，或加入我们的Discord社区寻求帮助。