From a757521313fb2c623d4dfda95eb97d3189bfe253 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 29 May 2023 00:44:08 +0000
Subject: [PATCH] base setup
---
content/notes/hosting.md | 21 +++++++++++++++------
1 files changed, 15 insertions(+), 6 deletions(-)
diff --git a/content/notes/hosting.md b/content/notes/hosting.md
index adda82d..e29f442 100644
--- a/content/notes/hosting.md
+++ b/content/notes/hosting.md
@@ -2,16 +2,21 @@
title: "Deploying Quartz to the Web"
tags:
- setup
-weight: 4
+weight: -1
+aliases:
+- hosting
---
-## GitHub Pages
+## Hosting on GitHub Pages
Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! Follow the steps below.
-### Enable GitHub Actions
-By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
+### Enable GitHub Actions Permissions
+By default, GitHub disables workflows from modifying your files (for good reason!). However, Quartz needs this to write the actual site files back to GitHub.
-*Enable GitHub Actions*
+Head to `Settings > Action > General > Workflow Permissions` and choose `Read and Write Permissions`
+
+![[notes/images/github-actions.png]]
+*Enable GitHub Actions*
### Enable GitHub Pages
@@ -64,7 +69,7 @@
[Reference `deploy.yaml` here](https://github.com/jackyzha0/quartz/blob/hugo/.github/workflows/deploy.yaml)
-```yaml
+```yaml {title=".github/workflows/deploy.yaml"}
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
@@ -81,6 +86,10 @@
❌ [Excluding pages from being published](notes/ignore%20notes.md)
+## Docker Support
+If you don't want to use a hosting service, you can host using [Docker](notes/docker.md) instead!
+I would *not use this method* unless you know what you are doing.
+
---
Now that your Quartz is live, let's figure out how to make Quartz really *yours*!
--
Gitblit v1.10.0