mirror of
https://github.com/jackyzha0/quartz.git
synced 2025-12-20 19:34:05 -06:00
15 lines
4.6 KiB
XML
15 lines
4.6 KiB
XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Notes on</title><link>https://quartz.jzhao.xyz/notes/</link><description>Recent content in Notes on</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://quartz.jzhao.xyz/notes/index.xml" rel="self" type="application/rss+xml"/><item><title>Configuration</title><link>https://quartz.jzhao.xyz/notes/config/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://quartz.jzhao.xyz/notes/config/</guid><description>Configuration Quartz is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you&rsquo;d like to get.
|
|
The majority of configuration can be be found under data/config.yaml. An annotated example configuration is shown below.
|
|
1 2 3 4 5 6 7 8 9 10 name:Your name here!# Shows in the footerenableToc:true# Whether to show a Table of Contentsdescription:Page description to show to search enginespage_title:Quartz Example Page# Default Page Titlelinks:# Links to show in footer- link_name:Twitterlink:https://twitter.</description></item><item><title>Deploying to GitHub Pages</title><link>https://quartz.jzhao.xyz/notes/hosting/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://quartz.jzhao.xyz/notes/hosting/</guid><description>GitHub Pages Quartz is designed to be effortless to deploy. If you forked and cloned Quartz directly from the repository, everything should already be good to go! You can head to &lt;YOUR-GITHUB-USERNAME.github.io/quartz to see it live.
|
|
Enable GitHub Actions By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the &lsquo;Actions&rsquo; tab of your forked repository and Enable Workflows to setup deploying your Quartz site!
|
|
Enable GitHub Actions</description></item><item><title>Editing Content in Quartz</title><link>https://quartz.jzhao.xyz/notes/editing/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://quartz.jzhao.xyz/notes/editing/</guid><description>Editing Quartz runs on top of Hugo so all notes are written in Markdown .
|
|
Obsidian I strongly recommend using Obsidian as a way to edit and grow your digital garden. It comes with a really nice editor and graphical interface to preview all of my local files.
|
|
🔗 How to link your Obsidian Vault
|
|
Of course, all the files are in Markdown so you could just use your favourite text editor of choice, I&rsquo;m not going to stop you!</description></item><item><title>Obsidian Vault Integration</title><link>https://quartz.jzhao.xyz/notes/obsidian/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://quartz.jzhao.xyz/notes/obsidian/</guid><description>Setup Obsidian is the preferred way to use Quartz. You can either create a new Obsidian Vault or link one that your already have.
|
|
New Vault If you don&rsquo;t have an existing Vault, download Obsidian and create a new Vault in the /content folder that you created and cloned during the setup .
|
|
Linking an existing Vault The easiest way to use an existing Vault is to copy all of our files (directory and hierarchies intact) into the /content folder.</description></item><item><title>Setup</title><link>https://quartz.jzhao.xyz/notes/setup/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://quartz.jzhao.xyz/notes/setup/</guid><description>Making your own Quartz Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!
|
|
Forking A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.
|
|
Navigate to the GitHub repository for the Quartz project:
|
|
📁 Quartz Repository Then, Fork the repository into your own GitHub account.</description></item><item><title>Troubleshooting and FAQ</title><link>https://quartz.jzhao.xyz/notes/troubleshooting/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://quartz.jzhao.xyz/notes/troubleshooting/</guid><description>Common Pitfalls Do I need a website already? No! Setting up Quartz means you set up a site too :)
|
|
command not found: hugo-obsidian Make sure you set your GOPATH correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.
|
|
1 2 3 4 5 6 # Add the following 2 lines to your ~/.bash_profile export GOPATH=/Users/$USER/go export PATH=$GOPATH/bin:$PATH # In your current terminal, to reload the session source ~/.</description></item></channel></rss> |