From f1c9ca495e450ecb62dade70c4b60d86e106f79c Mon Sep 17 00:00:00 2001 From: vintro <77507980+vintrocode@users.noreply.github.com> Date: Mon, 14 Aug 2023 00:19:50 +0000 Subject: [PATCH] docs: note about existing content at same path on different branches --- content/index.md | 28 +++++++++++++++++++--------- 1 files changed, 19 insertions(+), 9 deletions(-) diff --git a/content/index.md b/content/index.md index 5c32c23..4568151 100644 --- a/content/index.md +++ b/content/index.md @@ -6,7 +6,9 @@ ## ðŠī Get Started -Quartz requires **at least [Node](https://nodejs.org/) v16** to function correctly. In your terminal of choice, enter the following commands line by line: +Quartz requires **at least [Node](https://nodejs.org/) v18.14** to function correctly. Ensure you have this installed on your machine before continuing. + +Then, in your terminal of choice, enter the following commands line by line: ```shell git clone https://github.com/jackyzha0/quartz.git @@ -16,21 +18,29 @@ npx quartz create ``` -This will guide you through initializing your Quartz with content. +This will guide you through initializing your Quartz with content. Once you've done so, see how to: -When you're ready, you can edit `quartz.config.ts` to customize and configure Quartz more. Read the [[configuration]] page for more information on what each field in the configuration does. +1. [[authoring content|Author content]] in Quartz +2. [[configuration|Configure]] Quartz's behaviour +3. Change Quartz's [[layout]] +4. [[build|Build and preview]] Quartz +5. [[hosting|Host]] Quartz online -Then, when you're ready, see how to [[build]] and [[hosting|host]] Quartz. +> [!info] +> Coming from Quartz 3? See the [[migrating from Quartz 3|migration guide]] for the differences between Quartz 3 and Quartz 4 and how to migrate. ## ð§ Features -- [[full-text search|Full-text search]], [[graph view]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and many more right out of the box -- Simple JSX [[creating components|layouts and page components]] +- [[Obsidian compatibility]], [[full-text search]], [[graph view]], [[wikilinks]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and [many more](./features) right out of the box +- Hot-reload for both configuration and content +- Simple JSX layouts and [[creating components|page components]] - [[SPA Routing|Ridiculously fast page loads]] and tiny bundle sizes - Fully-customizable parsing, filtering, and page generation through [[making plugins|plugins]] -For a comprehensive list of features, visit the [features page](/features). You can read more the _why_ behind these features on the [[philosophy]] page. +For a comprehensive list of features, visit the [features page](/features). You can read more about the _why_ behind these features on the [[philosophy]] page and a technical overview on the [[architecture]] page. -### ð§ Troubleshooting +### ð§ Troubleshooting + Updating -Having trouble with Quartz? Try searching for your issue using the search feature. If you're still having trouble, feel free to [submit an issue](https://github.com/jackyzha0/quartz/issues) if you feel you found a bug or ask for help in our [Discord Community](https://discord.gg/cRFFHYye7t). +Having trouble with Quartz? Try searching for your issue using the search feature. If you haven't already, [[upgrading|upgrade]] to the newest version of Quartz to see if this fixes your issue. + +If you're still having trouble, feel free to [submit an issue](https://github.com/jackyzha0/quartz/issues) if you feel you found a bug or ask for help in our [Discord Community](https://discord.gg/cRFFHYye7t). -- Gitblit v1.10.0