From ef72f1bf707dca363cdab84da91e2acfaef8f276 Mon Sep 17 00:00:00 2001 From: Ammar Alakkad <am.alakkad@gmail.com> Date: Mon, 30 Dec 2024 16:03:57 +0000 Subject: [PATCH] Fix ObsidianFlavoredMarkdown source link (#1694) --- docs/setting up your GitHub repository.md | 35 ++++++++++++++++++++++++++--------- 1 files changed, 26 insertions(+), 9 deletions(-) diff --git a/docs/setting up your GitHub repository.md b/docs/setting up your GitHub repository.md index 4165517..43a556d 100644 --- a/docs/setting up your GitHub repository.md +++ b/docs/setting up your GitHub repository.md @@ -12,20 +12,37 @@ ![[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 -git remote add origin REMOTE-URL -``` - -To verify that you set the remote URL correctly, run the following command. - -```bash +# list all the repositories that are tracked git remote -v + +# if the origin doesn't match your own repository, set your repository as the origin +git remote set-url origin REMOTE-URL + +# if you don't have upstream as a remote, add it so updates work +git remote add upstream https://github.com/jackyzha0/quartz.git ``` -Then, you can sync the content to upload it to your repository. +Then, you can sync the content to upload it to your repository. This is a helper command that will do the initial push of your content to your repository. ```bash -npx quartz sync +npx quartz sync --no-pull ``` + +> [!warning]- `fatal: --[no-]autostash option is only valid with --rebase` +> You may have an outdated version of `git`. Updating `git` should fix this issue. + +In future updates, you can simply run `npx quartz sync` every time you want to push updates to your repository. + +> [!hint] Flags and options +> For full help options, you can run `npx quartz sync --help`. +> +> Most of these have sensible defaults but you can override them if you have a custom setup: +> +> - `-d` or `--directory`: the content folder. This is normally just `content` +> - `-v` or `--verbose`: print out extra logging information +> - `--commit` or `--no-commit`: whether to make a `git` commit for your changes +> - `--push` or `--no-push`: whether to push updates to your GitHub fork of Quartz +> - `--pull` or `--no-pull`: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing -- Gitblit v1.10.0