From 875d3f8e069125af9a7fa4734b9c89eda6970dd7 Mon Sep 17 00:00:00 2001 From: jackyzha0 Date: Mon, 19 Jul 2021 00:40:55 -0400 Subject: [PATCH] improve docs --- content/notes/editing.md | 4 ++-- content/notes/hosting.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/notes/editing.md b/content/notes/editing.md index 2cb95721b..0975f4926 100644 --- a/content/notes/editing.md +++ b/content/notes/editing.md @@ -22,8 +22,8 @@ Here's a rough overview of what's what. 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 -For example, I want to link this current document to `config.md`. -[A link to the config page](config.md) +For example, I want to link this current document to `notes/config.md`. +[A link to the config page](notes/config.md) ``` ### Front Matter diff --git a/content/notes/hosting.md b/content/notes/hosting.md index 4a5a06b99..db42aa179 100644 --- a/content/notes/hosting.md +++ b/content/notes/hosting.md @@ -9,7 +9,7 @@ Quartz is designed to be effortless to deploy. If you forked and cloned Quartz d ### Enable GitHub Actions By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the 'Actions' tab of your forked repository and Enable Workflows to setup deploying your Quartz site! -![Enable GitHub Actions](notes/images/github-actions.png)*Enable GitHub Actions* +![Enable GitHub Actions](/notes/images/github-actions.png)*Enable GitHub Actions* ### Enable GitHub Pages @@ -18,7 +18,7 @@ Head to the 'Settings' tab of your forked repository and go to the 'Pages' tab. 1. Set the source to deploy from `master` using `/ (root)` 2. Set a custom domain here if you have one! -![Enable GitHub Pages](notes/images/github-pages.png)*Enable GitHub Pages* +![Enable GitHub Pages](/notes/images/github-pages.png)*Enable GitHub Pages* ### Pushing Changes To see your changes on the internet, we need to push it them to GitHub. Quartz is essentially a `git` repository so updating it is the same workflow as you would follow as normal.