Skip to content

y1450/quartz-themes-demo

Repository files navigation

Motivation

I have two reasons to use Quartz as submodule,

  1. Keep my changes separate from Quartz. Better Maintability.
  2. Keep history of my notes private. I don't want notes github repo to be public. I use vercel to deploy because Github doesn't free deployments of private repos on github pages.

This setup makes following changes to Quartz

  • The Github Action is no longer used as we don't deploy on github pages.
  • we intialized the Quartz repo as a submodule, rather than cloning the original Quartz repo.

Instructions

Hugo Setup

  hugo new site mynotes
  cd mynotes
  git init
  git submodule add https://github.com/jackyzha0/quartz.git themes/quartz
  mkdir assets
  cd assets 
  mkdir indices
  cd ../
  cp -r themes/quartz/content ./
  ln -s themes/quartz/Makefile ./
  echo "theme = 'quartz'" >> config.toml
  git add .
  git commit -m "inital commit"
  make
  # to pull changes just go to theme directory and pull changes
  cd themes/quartz
  git pull origin hugo

Vercel setup

In the dashboard create a new project and import from the github repository image image

image