Quartz sync: Jul 22, 2024, 9:08 PM

.github/workflows/deploy.yaml

@@ -0,0 +1,43 @@
+name: Deploy Quartz site to GitHub Pages
+ 
+on:
+  push:
+    branches:
+      - v4
+ 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+ 
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+ 
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all history for git info
+      - uses: actions/setup-node@v4
+      - name: Install Dependencies
+        run: npm ci
+      - name: Build Quartz
+        run: npx quartz build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: public
+ 
+  deploy:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,3 +1,67 @@
+# DND Four Keeps
+
+Publish obsidian vault using a combination of two projects:
+- [Enveloppe Obsidian Plugin](https://github.com/Enveloppe/obsidian-enveloppe)
+- [Quartz](https://quartz.jzhao.xyz/) ([github](https://github.com/jackyzha0/quartz))
+
+Enveloppe handles rendering `dataview` which can't be done by quartz directly.
+This repository stores only the published notes, syncing the edited notes is a separate concern handled by another repository.
+
+## Enveloppe Plugin Setup
+
+1. Install and enable Obsidian Enveloppe plugin
+2. Configure github access
+3. Create [fine-grained token](https://github.com/settings/tokens?type=beta) with read/write access to `Contents` in the repository
+4. If syncing repository to git, add `/.obsidian/plugins/obsidian-mkdocs-publisher/env` which stores the secret to `.gitignore`
+5. In `File paths`, set:
+   - File Tree in repository: `Obsidian Path`
+   - Root folder: `content`
+   - Folder note: `index.md`
+6. In `Content`, set:
+   - Dataview: `on`
+
+## Quartz Local Setup
+
+### Install pnpm
+
+[Install `pnpm`][install-pnpm] to manage node versions and packages.
+
+[install-pnpm]: https://pnpm.io/installation
+
+### Install node
+
+```sh
+pnpm env use --global 20
+```
+
+### Install dependencies
+
+```sh
+pnpm install
+```
+
+### Configure
+
+```sh
+npx quartz create
+```
+
+Answered questions:
+- Choose how to initialize the content?
+  Empty Quartz
+- Choose how Quartz should resolve links in your content.
+  Treat links as relative paths
+
+### Run
+
+```sh
+npx quartz build --serve
+```
+
+### Configure deployment
+
+Followed https://quartz.jzhao.xyz/hosting#github-pages
+
 # Quartz v4
 
 > “[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming

content/index.md

@@ -0,0 +1,6 @@
+---
+title: Welcome to Quartz
+---
+
+This is a blank Quartz installation.
+See the [documentation](https://quartz.jzhao.xyz) for how to get started.