From 3c01b92cc46589ac4607d994b49f1327dba3f38e Mon Sep 17 00:00:00 2001 From: Jacky Zhao <j.zhao2k19@gmail.com> Date: Sat, 16 Dec 2023 19:04:18 +0000 Subject: [PATCH] docs: note embeds and update git hint --- docs/setting up your GitHub repository.md | 10 +++++++++- 1 files changed, 9 insertions(+), 1 deletions(-) diff --git a/docs/setting up your GitHub repository.md b/docs/setting up your GitHub repository.md index 4165517..9d42d19 100644 --- a/docs/setting up your GitHub repository.md +++ b/docs/setting up your GitHub repository.md @@ -12,10 +12,14 @@ ![[github-quick-setup.png]] -In your terminal of choice, navigate to the root of your Quartz folder. Then, run the following command, replacing `REMOTE-URL` with the URL you just copied from the previous step. +In your terminal of choice, navigate to the root of your Quartz folder. Then, run the following commands, replacing `REMOTE-URL` with the URL you just copied from the previous step. ```bash +# add your repository git remote add origin REMOTE-URL + +# track the main quartz repository for updates +git remote add upstream https://github.com/jackyzha0/quartz.git ``` To verify that you set the remote URL correctly, run the following command. @@ -29,3 +33,7 @@ ```bash npx quartz sync ``` + +> [!hint] +> If `npx quartz sync` fails with `fatal: --[no-]autostash option is only valid with --rebase`, you +> may have an outdated version of `git`. Updating `git` should fix this issue. -- Gitblit v1.10.0