Skip to content

saberzero1/quartz-syncer

 
 

Repository files navigation

Obsidian Quartz Syncer

Parse, upload and sync your Obsidian notes to your Quartz website.

This plugin assumes you have set up a Quartz repository.

Initial Setup

Install the plugin by downloading it from the Release Tab, or through the Obsidian42 Brat plugin.

After installing, open the plugin settings in Obsidian and set your Github Username, the name of your fork of Quartz, and the authentication token.

Don't have an authentication token yet? You can generate it here.

Publishing notes to Quartz

You can click on the icon in the sidebar or launch the Quartz Syncer: Open Publication Center to publish/unpublish notes.

Important

Notes need a publish flag in the notes frontmatter. You can add these with the Quartz Syncer: Add Publish Flag command, or by adding them to the notes properties manually or via template.

The following frontmatter in a note will cause it to be published when opening the Publication Center:

publish: true

The following frontmatter in a note will cause it to be shown in the Publication Center, but not published.

publish: false

The notes will appear in the content folder in your chosen repository.

Credits

This repository is a modified version of Ole's Digital Garden plugin. If you found this project useful and want to support it, please support him instead: Donation link.

About

Markdown publisher for Quartz with Dataview support.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 84.0%
  • Svelte 13.4%
  • JavaScript 2.2%
  • CSS 0.4%