From 3c01b92cc46589ac4607d994b49f1327dba3f38e Mon Sep 17 00:00:00 2001 From: Jacky Zhao Date: Sat, 16 Dec 2023 11:04:18 -0800 Subject: [PATCH] docs: note embeds and update git hint --- docs/features/wikilinks.md | 8 ++++++++ docs/setting up your GitHub repository.md | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/docs/features/wikilinks.md b/docs/features/wikilinks.md index 50bbb1bb6..1b005327c 100644 --- a/docs/features/wikilinks.md +++ b/docs/features/wikilinks.md @@ -14,3 +14,11 @@ This is enabled as a part of [[Obsidian compatibility]] and can be configured an - `[[Path to file | Here's the title override]]`: produces a link to `Path to file.md` with the text `Here's the title override` - `[[Path to file#Anchor]]`: produces a link to the anchor `Anchor` in the file `Path to file.md` - `[[Path to file#^block-ref]]`: produces a link to the specific block `block-ref` in the file `Path to file.md` + +### Embeds + +- `![[Path to image]]`: embeds an image into the page +- `![[Path to image|100x145]]`: embeds an image into the page with dimensions 100px by 145px +- `![[Path to file]]`: transclude an entire page +- `![[Path to file#Anchor]]`: transclude everything under the header `Anchor` +- `![[Path to file#^b15695]]`: transclude block with ID `^b15695` diff --git a/docs/setting up your GitHub repository.md b/docs/setting up your GitHub repository.md index ca67e85c9..9d42d199b 100644 --- a/docs/setting up your GitHub repository.md +++ b/docs/setting up your GitHub repository.md @@ -33,3 +33,7 @@ Then, you can sync the content to upload it to your repository. ```bash npx quartz sync ``` + +> [!hint] +> If `npx quartz sync` fails with `fatal: --[no-]autostash option is only valid with --rebase`, you +> may have an outdated version of `git`. Updating `git` should fix this issue.