Setup Guide

Set up Quartz first

This plugin manages Quartz content from Obsidian. Please set up Quartz on your Git provider before continuing.

Choose Your Git Provider

Quartz Syncer supports any Git provider. Choose your provider for complete setup instructions:

Provider	Guide	Hosting
GitHub	GitHub Setup	GitHub Pages (built-in)
GitLab	GitLab Setup	GitLab Pages (built-in)
Codeberg	Codeberg Setup	Codeberg Pages (built-in)
Bitbucket	Bitbucket Setup	Netlify, Cloudflare, Vercel
Other	See Generic Setup below	Varies

Each guide covers:

1. Creating a Quartz repository
2. Configuring automatic deployment
3. Generating an access token
4. Configuring Quartz Syncer

Generic Setup

For Git providers not listed above, follow these general steps:

1. Create a Quartz Repository

Clone or fork the Quartz repository to your Git provider.

2. Configure Hosting

Set up a CI/CD pipeline to build and deploy Quartz. The build process is:

npm ci
npx quartz build
# Deploy the 'public' folder to your hosting service

Popular hosting options:

• Netlify
• Cloudflare Pages
• Vercel

See the Quartz hosting documentation for more options.

3. Generate an Access Token

Create a personal access token with write access to your repository. The exact steps vary by provider.

4. Configure Quartz Syncer

In Obsidian, go to Settings > Community Plugins > Quartz Syncer and configure:

Setting	Value
Remote URL	https://<provider>/<user>/<repo>.git
Branch	Your Quartz branch (usually v4 or main)
Provider	Select your provider or “Custom”
Authentication Type	Username & Token/Password
Username	Your username (or oauth2 for some providers)
Access Token	Your generated token

A green checkmark indicates a successful connection.

Configure Quartz

After setting up your repository and Quartz Syncer, configure Quartz itself:

quartz.config.ts

Update these key settings in quartz.config.ts:

const config: QuartzConfig = {
  configuration: {
    pageTitle: "Your Site Title",
    baseUrl: "your-site.example.com", // Without https://
    defaultDateType: "modified", // or "created", "published"
  },
  plugins: {
    transformers: [
      Plugin.CrawlLinks({ markdownLinkResolution: "shortest" }),
      // Should match your Obsidian link settings
    ],
  },
}

That’s It

You’re ready to publish notes to Quartz using Quartz Syncer.

For usage instructions, see the Usage Guide.