Usage Guide

One-way sync only

Quartz Syncer applies changes to your notes when they are pushed to your Quartz repository, like parsing Dataview queries and filtering note properties to ensure your notes are fully Quartz-compatible. This means the notes in your Quartz repository should be considered a one-way sync (Obsidian to Quartz.)

For syncing notes between devices, consider using Obsidian Sync or one of the many community plugins.

Opening the publication center

There are two ways to open the publication center:

1. From the command palette: Quartz Syncer: Open publication center.
2. Clicking the Quartz crystal icon.
   1. (On desktop): By default, in the vertical bar on the left side of your screen.
   2. (On mobile): By default, press the hamburger button on the bottom right (three horizontal lines) and press Quartz Syncer publication center.

Marking files as publishable

By default, Quartz Syncer will not show any notes when you open the publication center. In order to flag a note as visible to Quartz Syncer, you will need to add a property to the notes you want to publish.

The publish property

By default, a checkbox property publish has to be added to notes to make them visible to Quartz Syncer. This property can be configured in the plugin settings. The checkbox has to be checked/property set to true to show up in Quartz Syncer.

Adding the publish property

There are several ways to add the publish property to your notes:

1. Using the Quartz Syncer command Quartz Syncer: add publication flag
2. Using a community plugin to automatically add the configured flag
3. Manually, via the + Add property button

Publishing notes to Quartz

Open the publication center (see above for instructions). Your eligible notes will be under one of the following headings:

• Unpublished notes: notes that are in your Obsidian vault, but not in your Quartz repository. Any notes checked here will be published to Quartz.
• Changed notes: notes that are in your Obsidian vault and in your Quartz repository, but they don’t match. This is usually because the note has been changed in your vault. Any notes checked here will be updated in Quartz.
  • You can click the icon next to your note’s title to preview the exact changes that will be made.
• Published notes (select to unpublished): notes that are in your in your Quartz repository. Any notes checked here will be unpublished and removed from your Quartz repository. Notes deleted from your vault need to be unpublished here to remove them from Quartz.
• Unchanged notes: a list of all unchanged notes that are currently published in your Quartz repository. It includes only unchanged notes that are also in your vault.

After you are satisfied with your selection, click the big button on the bottom left that says PUBLISH SELECTED CHANGES and watch the magic happen.

Why does Quartz Syncer sometimes make two commits?

To prevent any potential inconsistencies with git, Quartz Syncer sometimes makes two commits in a row: the first commit adds and/or updates any notes selected. The second commit removes any notes selected for unpublishing.

If you’re unsure if your notes have been correctly published, you can check by opening the publication center again after Quartz Syncer finished publishing. The new state of your notes should be reflected in the publication center.