mirror of
https://gitlab.com/MisterBiggs/brain-quartz.git
synced 2025-07-26 16:21:26 +00:00
.github
content
docs
advanced
features
images
tags
authoring content.md
build.md
configuration.md
hosting.md
index.md
layout.md
migrating from Quartz 3.md
philosophy.md
setting up your GitHub repository.md
showcase.md
upgrading.md
quartz
.gitattributes
.gitignore
.npmrc
.prettierignore
.prettierrc
CODE_OF_CONDUCT.md
Dockerfile
LICENSE.txt
README.md
globals.d.ts
index.d.ts
package-lock.json
package.json
quartz.config.ts
quartz.layout.ts
tsconfig.json
41 lines
2.2 KiB
Markdown
41 lines
2.2 KiB
Markdown
---
|
||
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|setup Quartz]] already, this folder should already be initialized. Any Markdown in this folder will get processed by Quartz.
|
||
|
||
It is recommended that you use [Obsidian](https://obsidian.md/) as a way to edit and maintain your Quartz. It comes with a nice editor and graphical interface to preview, edit, and link your local files and attachments.
|
||
|
||
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. By default, Quartz also ships with a few syntax extensions like [Github Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) (footnotes, strikethrough, tables, tasklists) and [Obsidian Flavored Markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown) ([[callouts]], [[wikilinks]]).
|
||
|
||
Additionally, Quartz also allows you to specify additional metadata in your notes called **frontmatter**.
|
||
|
||
```md title="content/note.md"
|
||
---
|
||
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`: Title of the page. If it isn't provided, Quartz will use the name of the file as the title.
|
||
- `description`: Description of the page used for link previews.
|
||
- `aliases`: Other names for this note. This is a list of strings.
|
||
- `tags`: Tags for this note.
|
||
- `draft`: Whether to publish the page or not. This is one way to make [[private pages|pages private]] in Quartz.
|
||
- `date`: A string representing the day the note was published. Normally uses `YYYY-MM-DD` format.
|
||
|
||
## Syncing your Content
|
||
|
||
When your Quartz is at a point you're happy with, you can save your changes to GitHub.
|
||
First, make sure you've [[setting up your GitHub repository|already setup your GitHub repository]] and then do `npx quartz sync`.
|