From dde36fa5589a362b60b7b72eb7793a3f133e159c Mon Sep 17 00:00:00 2001 From: Jacky Zhao <j.zhao2k19@gmail.com> Date: Wed, 07 Jun 2023 17:52:53 +0000 Subject: [PATCH] update gh actions --- content/notes/preview changes.md | 37 ++++++++++++++++++++++--------------- 1 files changed, 22 insertions(+), 15 deletions(-) diff --git a/content/notes/preview changes.md b/content/notes/preview changes.md index dac619e..6ce7fc0 100644 --- a/content/notes/preview changes.md +++ b/content/notes/preview changes.md @@ -1,34 +1,41 @@ --- title: "Preview Changes" +tags: +- setup +weight: -2 --- -If you'd like to preview what your Quartz site looks like before deploying it to the internet, here's exactly how to do that! +If you'd like to preview what your Quartz site looks like before deploying it to the internet, the following +instructions guide you through installing the proper dependencies to run it locally. + ## Install `hugo-obsidian` This step will generate the list of backlinks for Hugo to parse. Ensure you have [Go](https://golang.org/doc/install) (>= 1.16) installed. -```shell +```bash # Install and link `hugo-obsidian` locally -$ go install github.com/jackyzha0/hugo-obsidian - -# Navigate to your local Quartz folder -$ cd <location-of-your-local-quartz> - -# Scrape all links in your Quartz folder and generate info for Quartz -$ hugo-obsidian -input=content -output=data -index=true +go install github.com/jackyzha0/hugo-obsidian@latest ``` -Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated! +If you are running into an error saying that `command not found: hugo-obsidian`, make sure you set your `GOPATH` correctly (see [[notes/troubleshooting#`command not found: hugo-obsidian`|the troubleshooting page]])! This will allow your terminal to correctly recognize hugo-obsidian as an executable. ## Installing Hugo -Hugo is the static site generator that powers Quartz. If you'd like to preview your site locally, [install Hugo](https://gohugo.io/getting-started/installing/). +Hugo is the static site generator that powers Quartz. [Install Hugo with "extended" Sass/SCSS version](https://gohugo.io/getting-started/installing/) first. Then, -``` +```bash # Navigate to your local Quartz folder -$ cd <location-of-your-local-quartz> +cd <location-of-your-local-quartz> # Start local server -$ hugo server +make serve # View your site in a browser at http://localhost:1313/ -``` \ No newline at end of file +``` + +> [!INFO] Docker Support +> +> If you have the Docker CLI installed already, you can avoid installing `hugo-obsidian` and `hugo`. Instead, open your terminal, navigate to your folder with Quartz and run `make docker` + +Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated! Now, let's get it hosted online. + +> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md) -- Gitblit v1.10.0