ar.falsy.cat/content/notes/editing.md

75 lines
2.8 KiB
Markdown
Raw Normal View History

2021-07-18 19:19:58 +00:00
---
title: "Editing Content in Quartz"
2021-12-27 02:13:21 +00:00
tags:
- setup
2022-06-30 00:03:41 +00:00
weight: -4
2021-07-18 19:19:58 +00:00
---
## Editing
Quartz runs on top of [Hugo](https://gohugo.io/) so all notes are written in [Markdown](https://www.markdownguide.org/getting-started/).
2021-07-19 04:36:15 +00:00
### Folder Structure
Here's a rough overview of what's what.
2021-07-18 19:19:58 +00:00
**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.
2022-06-29 23:57:36 +00:00
**To edit the main home page, open `/content/_index.md`.**
2021-07-18 20:40:53 +00:00
2021-07-19 04:36:15 +00:00
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**.
2021-07-18 19:19:58 +00:00
```markdown
2021-07-19 04:40:55 +00:00
For example, I want to link this current document to `notes/config.md`.
[A link to the config page](notes/config.md)
2021-07-18 20:40:53 +00:00
```
2022-02-17 15:44:39 +00:00
Similarly, you can put local images anywhere in the `/content` folder.
2022-01-04 16:39:22 +00:00
```markdown
Example image (source is in content/notes/images/example.png)
![Example Image](/content/notes/images/example.png)
```
2022-06-29 23:57:36 +00:00
You can also use wikilinks if that is what you are more comfortable with!
2021-07-18 20:40:53 +00:00
### Front Matter
2022-01-04 16:39:22 +00:00
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.
2021-07-18 20:40:53 +00:00
2022-06-30 00:17:53 +00:00
```yaml
2021-07-18 20:40:53 +00:00
---
title: "Example Title"
2022-01-04 16:39:22 +00:00
tags:
- example-tag
2021-07-18 20:40:53 +00:00
---
Rest of your content here...
2021-07-18 19:19:58 +00:00
```
2022-06-29 23:57:36 +00:00
### Obsidian
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.
This step is **highly recommended**.
> 🔗 Step 3: [How to setup your Obsidian Vault to work with Quartz](notes/obsidian.md)
2021-07-18 19:19:58 +00:00
## Previewing Changes
2022-01-04 16:39:22 +00:00
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.
2021-07-19 04:36:15 +00:00
2022-06-29 23:57:36 +00:00
> 👀 Step 4: [Preview Quartz Changes](notes/preview%20changes.md)
2021-07-19 04:36:15 +00:00
If you prefer, you can preview changes by [hosting locally with Docker](notes/docker.md) instead! If you have Docker, this might be the easiest approach.
2021-07-19 22:02:16 +00:00
For those who like to live life more on the edge, viewing the garden through Obsidian gets you pretty close to the real thing.
2021-07-19 04:36:15 +00:00
2021-07-18 19:19:58 +00:00
## Publishing Changes
Now that you know the basics of managing your digital garden using Quartz, you can publish it to the internet!
2022-06-29 23:57:36 +00:00
> 🌍 Step 5: [Hosting Quartz online!](notes/hosting.md)
2021-07-18 19:19:58 +00:00
## Hosting with Docker
You can also choose to publish your digital garden on a local or remote machine using Docker.
> 🐳 [Hosting with Docker](notes/docker.md)
Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md).