From aa5ab03d4ad6e7cb4d9efd3f9c177ebde7e4c4af Mon Sep 17 00:00:00 2001 From: Jacky Zhao <j.zhao2k19@gmail.com> Date: Thu, 02 Mar 2023 17:14:29 +0000 Subject: [PATCH] docs: update to account for github changes --- content/notes/setup.md | 30 +++++++++--------------------- 1 files changed, 9 insertions(+), 21 deletions(-) diff --git a/content/notes/setup.md b/content/notes/setup.md index 0a008b1..0230132 100644 --- a/content/notes/setup.md +++ b/content/notes/setup.md @@ -2,6 +2,7 @@ title: "Setup" tags: - setup +weight: -5 --- ## Making your own Quartz @@ -14,35 +15,22 @@ 📁 [Quartz Repository](https://github.com/jackyzha0/quartz) -Then, Fork the repository into your own GitHub account. 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). +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 replacing `YOUR-USERNAME` with your GitHub username. +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 +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. -✏️ [Editing Notes in Quartz](notes/editing.md) +> ✏️ Step 2: [Editing Notes in Quartz](notes/editing.md) Having problems? Checkout our [FAQ and Troubleshooting guide](notes/troubleshooting.md). - -## Updating -Haven't updated Quartz in a while and want all the cool new optimizations? - -> ⚠️ **WARNING** ⚠️ -> -> if you customized `assets/styles/custom.scss`, the files in `data/`, or anything inside `layouts/`, your customization may be overwritten! - - -```shell -# add Quartz as a remote host -git remote add upstream git@github.com:jackyzha0/quartz.git - -# index and fetch changes -git fetch upstream -git checkout upstream/hugo -- layouts .github Makefile assets config.toml data static -``` -- Gitblit v1.10.0