The Obsidian Plugin Github Publisher (github link) works amazingly well with quartz! Not only does it allow you to update your digitalgarden straight from Obsidian (on both mobile & desktop no less!) but it also only uploads your published & public files to the repo! It also converts dataview queries into markdown before uploading!
Not only that but this is deployment agnostic, so if you don’t want to use GitHub Pages you don’t have to!
Setup
This guide assumes you have both run through the quartz setup and configured a deployment host. After that, follow these steps:
- Install the plugin (obviously)
- Generate a GitHub Token that has permissions to push and perform automatic PRs to your quartz repo
- Consider using a finegrained token for more security, though you’re forced to select a expiration date unlike the general one
- Open your GitHub Publisher options, and in the GitHub Config tab:
- Fill in your github username
- Fill in the name of your quartz repo
- Paste in the token you generated earlier
- Enter the branch your digital garden lives on (which is v4 by default)
- Toggle Automatically Merge Pull Requests to on
- Next, in the upload config tab, set file tree option to Obsidian Path and the root folder to content
- Finally, under the Plugin Settings tab, set the share key to publish if you are using the filter plugin ExplicitPublish
- (Optional) If you use dataview, in the Text & Link Converters tab toggle the Dataview option
- (optional) in the Plugin Settings tab, turn on Copy Link and set Base Link to your site’s domain!
And that’s it! Now just run Github Publisher: Upload all shared notes and wait for the deployment to build! There are many other settings you can apply, such as automatically renaming a file or path (I use this for my index.md!) To explore all of your options, check out the plugin’s documentation
FAQ
- Q: publishing doesn’t work! I get a
httperror: not found- A: make sure you don’t have a VPN on! sometimes that can cause http issues (but not all the time)