From 3583265f80afa081bf7a1fe996a9b3fe3c4e32e0 Mon Sep 17 00:00:00 2001 From: meleu <meleu@users.noreply.github.com> Date: Mon, 04 Apr 2022 20:30:23 +0000 Subject: [PATCH] docs: warn about possible lost of customization --- content/notes/setup.md | 44 ++++++++++++++++++++++++++++++++++++++++++-- 1 files changed, 42 insertions(+), 2 deletions(-) diff --git a/content/notes/setup.md b/content/notes/setup.md index 6f7bdc2..0a008b1 100644 --- a/content/notes/setup.md +++ b/content/notes/setup.md @@ -1,8 +1,48 @@ --- title: "Setup" +tags: +- setup --- - +## 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. + +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. 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). + +### 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. + +```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. + +✏️ [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! -Having problems? [troubleshooting](notes/troubleshooting.md) \ No newline at end of file +```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