keb/jpg-quartz
1
0
Fork 0
mirror of https://github.com/ZetaKebab/quartz.git synced 2025-06-23 01:04:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs on github pages and syncing

Browse Source
This commit is contained in:
Jacky Zhao
2023-08-18 18:22:38 -07:00
parent 6f1f820289
commit d8bec631b6
2 changed files with 21 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
content/authoring content.md
View File

@ -31,3 +31,18 @@ Some common frontmatter fields that are natively supported by Quartz:
- `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