mirror of
https://github.com/ZetaKebab/quartz.git
synced 2025-06-22 08:44:36 +00:00
doc bump
This commit is contained in:
34
content/notes/preview-changes.md
Normal file
34
content/notes/preview-changes.md
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
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!
|
||||
|
||||
## 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
|
||||
$ 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
|
||||
```
|
||||
|
||||
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. If you'd like to preview your site locally, [install Hugo](https://gohugo.io/getting-started/installing/).
|
||||
|
||||
```
|
||||
# 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/
|
||||
```
|
Reference in New Issue
Block a user