Setup

Last updated Jul 8, 2023 Edit Source

• Setup

Setting up Quartz requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start!

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. Make sure that when you fork, you uncheck the ‘Copy the hugo branch only’ option.

If you don’t have an account, you can make on for free here. More details about forking a repo can be found on GitHub’s documentation.

fork.png

After you’ve made a fork of the repository, you need to download the files locally onto your machine. Ensure you have git, then type the following command in your terminal replacing YOUR-USERNAME with your GitHub username.

1

git clone https://github.com/YOUR-USERNAME/quartz

Great! Now you have everything you need to start editing and growing your digital garden. If you’re ready to start writing content already, check out the recommended flow for editing notes in Quartz.

✏️ Step 2: Editing Notes in Quartz

Having problems? Checkout our FAQ and Troubleshooting guide.