From d8bec631b6dee8f5b9c42f75d154252e53e81b77 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sat, 19 Aug 2023 01:22:38 +0000
Subject: [PATCH] update docs on github pages and syncing

---
 content/authoring content.md |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)

diff --git a/content/authoring content.md b/content/authoring content.md
index 4e3c3c8..7aa8d62 100644
--- a/content/authoring content.md
+++ b/content/authoring content.md
@@ -31,3 +31,18 @@
 - `aliases`: Other names for this note. This is a list of strings.
 - `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 you're Quartz is at a point you're happy with, you can save your changes to GitHub by doing `npx quartz sync`.
+
+> [!hint] Flags and options
+> For full help options, you can run `npx quartz sync --help`.
+>
+> Most of these have sensible defaults but you can override them if you have a custom setup:
+>
+> - `-d` or `--directory`: the content folder. This is normally just `content`
+> - `-v` or `--verbose`: print out extra logging information
+> - `--commit` or `--no-commit`: whether to make a `git` commit for your changes
+> - `--push` or `--no-push`: whether to push updates to your GitHub fork of Quartz
+> - `--pull` or `--no-pull`: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing

--
Gitblit v1.10.0