Quartz 5

how to set this up

2 min read

Step 1: repo reset

First, we need to do some resetting of the contents in the repo. I’ll do a hard reset to match my repo. This will set up a vanilla installation of Quartz along with the workflow to build the site.

This step will also delete everything currently in the content/ folder in the repo, so I want to make sure that’s okay before doing this myself.

Step 2: Set up Quartz Syncer in Obsidian

  1. Install the Quartz Syncer extension in Obsidian.
  2. Get an access token from source.tube
    1. Give it access only to the digital-garden repository
    2. Enable Repository > Read and write
    3. Generate and copy this access token
  3. In Settings > Quartz Syncer > Git, set these values:
    1. Remote URL: https://source.tube/digitalsnow/digital-garden.git
    2. Branch: v5
    3. Provider: Custom / self-hosted
    4. Authentication type: Bearer token
    5. Access token → paste in the access token from source.tube
    6. CORS proxy: https://cors.isomorphic-git.org
  4. Test the connection, should work!

Next, in order for a page to be published, it needs to have a property called “publish” with a type of “Checkbox”, and the checkbox needs to be checked.

Note

If you want to have every new note automatically set up with the property, we can automate that with the Templater plugin! Just let me know.

Next, make sure there is a note with the exact filename index.md with the publish property checked. This is the landing page in Quartz.

Step 3: Set up domain

DNS:

  • Create a TXT record
    • Name: _git-pages-forge-allowlist.{domain}
    • Value: https://source.tube/digitalsnow/digital-garden.git
    • TTL: 300
  • Create a CNAME record
    • Name: {domain}
    • Value: grebedoc.dev.
    • TTL: 300

Then configure Quartz: configuration.baseUrl: {domain}

Then update the deploy Action to use this domain.

Next steps

  • The action only runs manually right now. You probably want to automate this.
  • Set up email notifications if the deploy process fails.
  • Set up a preview site?
  • Step through the configuration to see what you want to keep and what you want to customize

Graph View

Backlinks