roadmap/content/notes/preview changes.md

39 lines
1.4 KiB
Markdown
Raw Normal View History

2021-07-19 22:02:16 +00:00
---
title: "Preview Changes"
---
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!
2022-02-17 15:44:39 +00:00
Note that both of these steps need to be completed.
2021-07-19 22:02:16 +00:00
## 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
# Install and link `hugo-obsidian` locally
2022-01-04 16:39:22 +00:00
$ go install github.com/jackyzha0/hugo-obsidian@latest
2021-07-19 22:02:16 +00:00
# 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=.
2021-07-19 22:02:16 +00:00
```
2022-02-17 15:44:39 +00:00
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.
2021-07-19 22:02:16 +00:00
Afterwards, start the Hugo server as shown above and your local backlinks and interactive graph should be populated!
## 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,
2021-07-19 22:02:16 +00:00
```
# Navigate to your local Quartz folder
$ cd <location-of-your-local-quartz>
# Start local server
$ hugo server
# View your site in a browser at http://localhost:1313/
```