From a757521313fb2c623d4dfda95eb97d3189bfe253 Mon Sep 17 00:00:00 2001 From: Jacky Zhao <j.zhao2k19@gmail.com> Date: Mon, 29 May 2023 00:44:08 +0000 Subject: [PATCH] base setup --- content/notes/setup.md | 32 ++++++++++++++++++++++++++++++-- 1 files changed, 30 insertions(+), 2 deletions(-) diff --git a/content/notes/setup.md b/content/notes/setup.md index 6f7bdc2..0230132 100644 --- a/content/notes/setup.md +++ b/content/notes/setup.md @@ -1,8 +1,36 @@ --- title: "Setup" +tags: +- setup +weight: -5 --- - +## Making your own Quartz +Setting up Quartz requires a basic understanding of `git`. If you are unfamiliar, [this resource](https://resources.nwplus.io/2-beginner/how-to-git-github.html) 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. -Having problems? [troubleshooting](notes/troubleshooting.md) \ No newline at end of file +Navigate to the GitHub repository for the Quartz project: + +📁 [Quartz Repository](https://github.com/jackyzha0/quartz) + +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](https://github.com/join). More details about forking a repo can be found on [GitHub's documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). + +![[notes/images/fork.png]] + +### Cloning +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. + +```shell +git clone https://github.com/YOUR-USERNAME/quartz +``` + +## Editing +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](notes/editing.md) + +Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). -- Gitblit v1.10.0