You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

69 lines
2.7 KiB
Markdown

---
title: "Editing Content in Quartz"
3 years ago
tags:
- setup
---
## Editing
Quartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).
3 years ago
### Obsidian
3 years ago
I recommend using [Obsidian](http://obsidian.md/) as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of your local files.
3 years ago
3 years ago
This step is **highly recommended**.
3 years ago
3 years ago
🔗 [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md)
3 years ago
### Ignoring Files
Only want to publish a subset of all of your notes? Don't worry, Quartz makes this a simple two-step process.
❌ [Excluding pages from being published](notes/ignore%20notes.md)
3 years ago
### Folder Structure
Here's a rough overview of what's what.
**All content in your garden can found in the `/content` folder.** To make edits, you can open any of the files and make changes directly and save it. You can organize content into any folder you'd like.
3 years ago
**To edit the main home page, open `/content/_index.md`.** This is the home page which is slightly special. You don't need front matter here!
3 years ago
3 years ago
To create a link between notes in your garden, just create a normal link using Markdown pointing to the document in question. Please note that **all links should be relative to the root `/content` path**.
```markdown
3 years ago
For example, I want to link this current document to `notes/config.md`.
[A link to the config page](notes/config.md)
3 years ago
```
3 years ago
Similarly, you can put local images anywhere in the `/content` folder. The only caveat is that you should reference them in your Markdown by prefixing it with a `/`.
```markdown
Example image (source is in content/notes/images/example.png)
![Example Image](/content/notes/images/example.png)
```
3 years ago
### Front Matter
3 years ago
Hugo is picky when it comes to metadata for files. Make sure that your title is double-quoted and that you have a title defined at the top of your file like so. You can also add tags here as well.
3 years ago
```markdown
---
title: "Example Title"
3 years ago
tags:
- example-tag
3 years ago
---
Rest of your content here...
```
## Previewing Changes
3 years ago
This step is purely optional and mostly for those who want to see the published version of their digital garden locally before opening it up to the internet. This is *highly recommended* but not required.
3 years ago
👀 [Preview Quartz Changes](notes/preview%20changes.md)
3 years ago
3 years ago
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
3 years ago
## Publishing Changes
Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
🌍 [Hosting Quartz online!](notes/hosting.md)
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).