From be9b6b3a1e2038ea0a985ebd37fb18a661bddd04 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 23 Feb 2024 17:32:22 +0000
Subject: [PATCH] fix(docs): make docs accurate to callout behaviour (closes #920)
---
docs/configuration.md | 5 +++--
1 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/configuration.md b/docs/configuration.md
index b0c8506..366430c 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -25,8 +25,9 @@
- `enablePopovers`: whether to enable [[popover previews]] on your site.
- `analytics`: what to use for analytics on your site. Values can be
- `null`: don't use analytics;
- - `{ provider: 'plausible' }`: use [Plausible](https://plausible.io/), a privacy-friendly alternative to Google Analytics; or
- - `{ provider: 'google', tagId: <your-google-tag> }`: use Google Analytics
+ - `{ provider: 'google', tagId: '<your-google-tag>' }`: use Google Analytics;
+ - `{ provider: 'plausible' }` (managed) or `{ provider: 'plausible', host: '<your-plausible-host>' }` (self-hosted): use [Plausible](https://plausible.io/);
+ - `{ provider: 'umami', host: '<your-umami-host>', websiteId: '<your-umami-website-id>' }`: use [Umami](https://umami.is/);
- `locale`: used for [[i18n]] and date formatting
- `baseUrl`: this is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `quartz.jzhao.xyz` for this site). Do not include the protocol (i.e. `https://`) or any leading or trailing slashes.
- This should also include the subpath if you are [[hosting]] on GitHub pages without a custom domain. For example, if my repository is `jackyzha0/quartz`, GitHub pages would deploy to `https://jackyzha0.github.io/quartz` and the `baseUrl` would be `jackyzha0.github.io/quartz`
--
Gitblit v1.10.0