From 9e298dd25de7d1a1249420ee1709483265d3b6ec Mon Sep 17 00:00:00 2001 From: Jacky Zhao Date: Tue, 5 Apr 2022 00:09:56 -0700 Subject: [PATCH] docs: make update command and clarify update steps/potential danger --- Makefile | 7 ++++++- content/notes/setup.md | 16 +++++++++++++--- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 50edc2d7..9beee0f8 100644 --- a/Makefile +++ b/Makefile @@ -7,7 +7,12 @@ update: ## Update Quartz to the latest version on Github @git remote show upstream || (echo "remote 'upstream' not present, setting 'upstream'" && git remote add upstream https://github.com/jackyzha0/quartz.git) git fetch upstream git log --oneline --decorate --graph ..upstream/hugo - git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data + git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data + +update-force: ## Forcefully pull all changes and don't ask to patch + @git remote show upstream || (echo "remote 'upstream' not present, setting 'upstream'" && git remote add upstream https://github.com/jackyzha0/quartz.git) + git fetch upstream + git checkout upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data serve: ## Serve Quartz locally hugo-obsidian -input=content -output=assets/indices -index -root=. && hugo server --enableGitInfo diff --git a/content/notes/setup.md b/content/notes/setup.md index 0a008b17..495a43b6 100644 --- a/content/notes/setup.md +++ b/content/notes/setup.md @@ -31,11 +31,21 @@ Great! Now you have everything you need to start editing and growing your digita 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? +Haven't updated Quartz in a while and want all the cool new optimizations? On Unix/Mac systems you can run the following command for a one-line update! This command will show you a log summary of all commits since you last updated, press `q` to acknowledge this. Then, it will show you each change in turn and press `y` to accept the patch or `n` to reject it. Usually you should press `y` for most of these unless it conflicts with existing changes you've made! + +```shell +make update + +# or, if you don't want the interactive parts and just want the update +make update-force +``` + +Or, manually checkout the changes yourself. > ⚠️ **WARNING** ⚠️ > -> if you customized `assets/styles/custom.scss`, the files in `data/`, or anything inside `layouts/`, your customization may be overwritten! +> If you customized the files in `data/`, or anything inside `layouts/`, your customization may be overwritten! +> Make sure you have a copy of these changes if you don't want to lose them. ```shell @@ -44,5 +54,5 @@ 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 +git checkout -p upstream/hugo -- layouts .github Makefile assets/js assets/styles/base.scss assets/styles/darkmode.scss config.toml data ```