feat: Making Quartz available offline by making it a PWA

docs/configuration.md

@@ -2,7 +2,7 @@
 title: Configuration
 ---
 
-Quartz is meant to be extremely configurable, even if you don't know any coding. Most of the configuration you should need can be done by just editing `quartz.config.ts` or changing [[layout|the layout]] in `quartz.layout.ts`.
+Quartz is meant to be extremely configurable, even if you don't know any coding. Most of the configuration you should need can be done by just editing `quartz.config.ts`, changing [[layout|the layout]] in `quartz.layout.ts` or adjusting cachine in `workbox.config.ts`.
 
 > [!tip]
 > If you edit Quartz configuration using a text-editor that has TypeScript language support like VSCode, it will warn you when you you've made an error in your configuration, helping you avoid configuration mistakes!
@@ -21,10 +21,12 @@ const config: QuartzConfig = {
 This part of the configuration concerns anything that can affect the whole site. The following is a list breaking down all the things you can configure:
 
 - `pageTitle`: title of the site. This is also used when generating the [[RSS Feed]] for your site.
+- `description`: description of the site. This will be used when someone installs your site as an App.
 - `enableSPA`: whether to enable [[SPA Routing]] on your site.
 - `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: "umami", websiteId: <your-umami-id> }`: easy, privacy-friendly, open source, GDPR Compliant 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
 - `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.
@@ -79,4 +81,13 @@ transformers: [
 ]
 ```
 
+## Caching
+
+<!-- I'm not sure how to explain it in an easy way, this would do for the beginning? -->
+
+In the `workbox.config.ts` you can adjust how caching behaves. This describes what Quartz should save on the persons computer.
+
+The `globPatterns` property defines what kind of files should be cached using Regex.
+Further documentation about this file can be found [here](https://developer.chrome.com/docs/workbox/reference/workbox-build/#type-GenerateSWOptions)
+
 If you'd like to make your own plugins, read the guide on [[making plugins]] for more information.