ndumas
/
quartz
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve docs

Browse Source
hugo
jackyzha0 3 years ago
parent c0ee39a937
commit 875d3f8e06
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File

4
content/notes/editing.md
Unescape Escape View File

@ -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**. 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 ```markdown
For example, I want to link this current document to `config.md`. For example, I want to link this current document to `notes/config.md`.
[A link to the config page](config.md) [A link to the config page](notes/config.md)
``` ```
### Front Matter ### Front Matter

4
content/notes/hosting.md
Unescape Escape View File

@ -9,7 +9,7 @@ Quartz is designed to be effortless to deploy. If you forked and cloned Quartz d
### Enable GitHub Actions ### 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! 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 ### 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)` 1. Set the source to deploy from `master` using `/ (root)`
2. Set a custom domain here if you have one! 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 ### 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. 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.

Write Preview
Loading…
Cancel
Save