您 Quartz 中的所有内容都应放置在 /content
目录中。主页内容位于 content/index.md
。如果您已经设置好 Quartz,该目录应该已经初始化完成。此目录中的所有 Markdown 文件都将被 Quartz 处理。
建议您使用 Obsidian 来编辑和维护 Quartz。它提供了友好的编辑器和图形界面,可以预览、编辑并链接本地文件与附件。
已完成所有设置?让我们开始本地构建并预览您的 Quartz 吧!
语法
由于 Quartz 使用 Markdown 文件作为主要的内容编写方式,它完全支持 Markdown 语法。默认情况下,Quartz 还附带了一些语法扩展,如 Github 风味 Markdown(脚注、删除线、表格、任务列表)和 Obsidian 风味 Markdown(标注、维基链接)。
此外,Quartz 还允许您在笔记中指定名为 frontmatter 的额外元数据。
---
title: Example Title
draft: false
tags:
- example-tag
---
The rest of your content lives here. You can use **Markdown** here :)
Quartz 原生支持的一些常见 Frontmatter 字段:
title
: 页面标题。如果未提供,Quartz 将使用文件名作为标题。description
: 用于链接预览的页面描述。permalink
: 页面的自定义永久链接,即使文件路径变更仍保持恒定。aliases
: 该笔记的其他名称(字符串列表)。tags
: 该笔记的标签。draft
: 是否发布页面。这是在 Quartz 中创建private pages的一种方式。date
: 表示笔记发布日期的字符串,通常使用YYYY-MM-DD
格式。
同步内容
当您的 Quartz 达到满意状态时,可以将更改保存到 GitHub。请先确保您已setting up your GitHub repository,然后执行 npx quartz sync
。
自定义配置
title
、tags
、aliases
和 cssclasses
的 Frontmatter 解析功能由Frontmatter插件提供,date
由CreatedModifiedDate插件处理,description
由Description插件处理。具体自定义选项请参阅各插件页面。