From 6eed73327bcdda95148d5bdc0e57fdc00fd05b25 Mon Sep 17 00:00:00 2001 From: ruinivist Date: Sun, 29 Mar 2026 02:38:04 +0000 Subject: [PATCH] docs: add mine placeholders and setup notes --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 01e2c58..c974524 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,24 @@ Quartz is a set of tools that helps you publish your [digital garden](https://jz [Join the Discord Community](https://discord.gg/cRFFHYye7t) +## MINE + +Fill these placeholders before using this branch for your own site: + +- `quartz.config.ts` + - `pageTitle: "TITLE"` + - `baseUrl: "YOUR-DOMAIN.com"` +- `quartz/i18n/locales/en-US.ts` + - `components.explorer.title = "TITLE"` +- `quartz/components/RuinsFooter.tsx` + - replace `FOOTER TEXT` +- `quartz/components/RuinsDarkmode.tsx` + - replace `LIGHT LABEL` + - replace `DARK LABEL` + +The color palette is intentionally left as-is. `quartz.config.ts` and `quartz/styles/custom.scss` +also include short comments describing what the custom knobs affect. + ## Sponsors