From fa8d87a23a85a6ccb4dd716f4930fb7f55f809e8 Mon Sep 17 00:00:00 2001 From: Jacky Zhao Date: Thu, 8 Jan 2026 09:04:56 +0800 Subject: [PATCH] docs: link fixes and cleanup --- README.md | 1 - docs/features/Docker Support.md | 4 ++++ docs/features/popover previews.md | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 27d6dbd..01e2c58 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ > “[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming Quartz is a set of tools that helps you publish your [digital garden](https://jzhao.xyz/posts/networked-thought) and notes as a website for free. -Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use. 🔗 Read the documentation and get started: https://quartz.jzhao.xyz/ diff --git a/docs/features/Docker Support.md b/docs/features/Docker Support.md index a31fb5b..a7fb6a2 100644 --- a/docs/features/Docker Support.md +++ b/docs/features/Docker Support.md @@ -5,3 +5,7 @@ You can run the below one-liner to run Quartz in Docker. ```sh docker run --rm -itp 8080:8080 -p 3001:3001 -v ./content:/usr/src/app/content $(docker build -q .) ``` + +> [!warning] Not to be used for production +> Serve mode is intended for local previews only. +> For production workloads, see the page on [[hosting]]. diff --git a/docs/features/popover previews.md b/docs/features/popover previews.md index 0666047..9b70149 100644 --- a/docs/features/popover previews.md +++ b/docs/features/popover previews.md @@ -8,7 +8,7 @@ By default, Quartz only fetches previews for pages inside your vault due to [COR When [[creating components|creating your own components]], you can include this `popover-hint` class to also include it in the popover. -Similar to Obsidian, [[quartz layout.png|images referenced using wikilinks]] can also be viewed as popups. +Similar to Obsidian, [[quartz-layout-desktop.png|images referenced using wikilinks]] can also be viewed as popups. ## Configuration