From 712dab5c8cd8933d9cdb63d4c833940c461a09da Mon Sep 17 00:00:00 2001 From: Jacky Zhao <j.zhao2k19@gmail.com> Date: Tue, 31 Jan 2023 19:00:28 +0000 Subject: [PATCH] docs: remove broken links from showcase --- content/notes/preview changes.md | 31 ++++++++++++++++++------------- 1 files changed, 18 insertions(+), 13 deletions(-) diff --git a/content/notes/preview changes.md b/content/notes/preview changes.md index 8d2a389..8ea07a3 100644 --- a/content/notes/preview changes.md +++ b/content/notes/preview changes.md @@ -1,23 +1,20 @@ --- 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. -Note that both of these steps need to be completed. ## 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@latest - -# 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=static -index -root=. +go install github.com/jackyzha0/hugo-obsidian@latest ``` If you are running into an error saying that `command not found: hugo-obsidian`, make sure you set your `GOPATH` correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable. @@ -27,12 +24,20 @@ ## Installing Hugo 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/ ``` + +> [!INFO] Docker Support +> +> If you have Docker installed already, open your terminal, navigate to your folder with Quartz and run `make docker` + +Now that you are happy with how your Quartz instance looks, let's get it hosted! + +> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md) -- Gitblit v1.10.0