docs: polish and update

This commit is contained in:
Jacky Zhao 2022-06-29 16:57:36 -07:00
parent 200c605142
commit 8a100edeb8
8 changed files with 159 additions and 96 deletions
content/notes

View file

@ -1,5 +1,6 @@
---
title: "Preview Changes"
weight: 3
---
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!
@ -12,12 +13,6 @@ This step will generate the list of backlinks for Hugo to parse. Ensure you have
```shell
# 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=assets/indices -index -root=.
```
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.
@ -32,7 +27,9 @@ Hugo is the static site generator that powers Quartz. [Install Hugo with "extend
$ cd <location-of-your-local-quartz>
# Start local server
$ hugo server
$ make serve
# View your site in a browser at http://localhost:1313/
```
> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)