wiki/content/authoring content.md
2023-08-11 00:31:44 -07:00

1.9 KiB

title
Authoring Content

All of the content in your Quartz should go in the /content folder. The content for the home page of your Quartz lives in content/index.md. If you've index#🪴 Get Started already, this folder should already be initailized. Any Markdown in this folder will get processed by Quartz.

It is recommended that you use Obsidian as a way to edit and maintain your Quartz. It comes with a nice editor and graphical interface to preview all of your local files and allow you to easily edit and link across files.

Got everything setup? Let's build and preview your Quartz locally!

Syntax

As Quartz uses Markdown files as the main way of writing content, it fully supports Markdown syntax along with a few extensions like Github Flavored Markdown (footnotes, strikethrough, tables, tasklists) and Obsidian Flavored Markdown (callouts, wikilinks).

Additionally, Quartz also allows you to specify additional metadata in your notes called frontmatter using YAML.

---
title: Example Title
draft: false
tags:
  - example-tag
---

The rest of your content lives here. You can use **Markdown** here :)

Some common frontmatter fields that are natively supported by Quartz:

  • title: Quartz will use the name of the file as the title if this isn't provided. If it is provided, it should be a string.
  • draft: Whether to publish the page or not. This is one way to make private pages in Quartz.
  • aliases: Other names for this note. This is a list of strings.
  • date: A string representing the day the note was published. Normally uses YYYY-MM-DD format but other formats may work.