feat: Making Quartz available offline by making it a PWA (jackyzha0#465)

* Adding PWA and chaching for offline aviability * renamed workbox config to fit Quartz' scheme * Documenting new configuration * Added missig umami documentation * Fixed formatting so the build passes, thank you prettier :) * specified caching strategies to improve performance * formatting... * fixing "404 manifest.json not found" on subdirectories by adding a / to manifestpath * turning it into a plugin * Removed Workbox-cli and updated @types/node * Added Serviceworkercode to offline.ts * formatting * Removing workbox from docs * applied suggestions * Removed path.join for sw path Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * Removed path.join for manifest path Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * Removing path module import * Added absolute path to manifests start_url and manifest "import" using baseUrl * Adding protocol to baseurl Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * Adding protocol to start_url too then * formatting... * Adding fallback page * Documenting offline plugin * formatting... * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * merge suggestion Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com> * formatting... * Fixing manifest path, all these nits hiding the actual issues .-. * Offline fallback page through plugins, most things taken from 404 Plugin * adding Offline Plugin to config * formatting... * Turned offline off as default and removed offline.md --------- Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
bfahrenfort · Sep 20, 2023 · d3fa6f8 · d3fa6f8
1 parent 68537a3
commit d3fa6f8
Show file tree

Hide file tree

Showing 13 changed files with 235 additions and 6 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -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.

diff --git a/docs/features/offline access.md b/docs/features/offline access.md
@@ -0,0 +1,31 @@
+---
+title: "Offline Access (PWA)"
+tags:
+  - plugin/emitter
+---
+
+This plugin allows your website to be accessible offline and be installed as an app. You can use it by adding `Plugin.Offline(),` to the `emitters` in `quartz.config.ts`
+
+## Offline Capability
+
+Whenever you visit a page it gets cached for offline use. Depending on the kind of content, the process for caching is diffent:
+
+- **Pages** (HTML, your converted Markdown files): Quartz first tries to get them over the Network. If that fails, your browser attempts to fetch it from the cache.
+- **Static Resources** (Fonts, CSS Styling, JavaScript): Quartz uses cached resources by default and updates the cache over the network in the background.
+- **Images**: Images are saved once and then served from cache. Quartz uses a limited cache of 60 images and images remain in the cache for 30 days
+
+You can edit the fallback page by changing the `offline.md` file in the root of your `content` directory
+
+## Progressive Web App (PWA)
+
+Progressive Web Apps can have [many properties](https://developer.mozilla.org/en-US/docs/Web/Manifest). We're only going to mention the ones Quartz supports by default, however you can edit the offline plugins file to add more in case required.
+
+- **icons**: the `icon.svg` file in the `quartz/static` directory is used for all the icons. This makes it easier to scale the image since you don't need to provide an png for every size
+- **name**, **short_name**: Uses the `pageTitle` configured in `quartz.config.ts`
+- **description**: Uses the `description` configured in `quartz.config.ts`
+- **background_color**, **theme_color**: Uses the `lightMode.light` color configured in `quartz.config.ts`.
+- **start_url**: Uses the `baseUrl` configured in `quartz.config.ts`
+
+### Default values
+
+- **display**: this is set to `minimal-ui`
diff --git a/docs/index.md b/docs/index.md
@@ -30,7 +30,7 @@ This will guide you through initializing your Quartz with content. Once you've d
 
 ## 🔧 Features
 
-- [[Obsidian compatibility]], [[full-text search]], [[graph view]], note transclusion, [[wikilinks]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], and [many more](./features) right out of the box
+- [[Obsidian compatibility]], [[full-text search]], [[graph view]], note transclusion, [[wikilinks]], [[backlinks]], [[Latex]], [[syntax highlighting]], [[popover previews]], [[offline access]] 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

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -94,7 +94,7 @@
     "@types/flexsearch": "^0.7.3",
     "@types/hast": "^2.3.4",
     "@types/js-yaml": "^4.0.5",
-    "@types/node": "^20.1.2",
+    "@types/node": "^20.6.2",
     "@types/pretty-time": "^1.1.2",
     "@types/source-map-support": "^0.5.6",
     "@types/workerpool": "^6.4.0",

diff --git a/quartz.config.ts b/quartz.config.ts
@@ -4,6 +4,7 @@ import * as Plugin from "./quartz/plugins"
 const config: QuartzConfig = {
   configuration: {
     pageTitle: "🪴 Quartz 4.0",
+    description: "Quartz Documentation Page and Demo",
     enableSPA: true,
     enablePopovers: true,
     analytics: {

diff --git a/quartz/cfg.ts b/quartz/cfg.ts
@@ -19,6 +19,7 @@ export type Analytics =
 
 export interface GlobalConfiguration {
   pageTitle: string
+  description: string
   /** Whether to enable single-page-app style rendering. this prevents flashes of unstyled content and improves smoothness of Quartz */
   enableSPA: boolean
   /** Whether to display Wikipedia-style popovers when hovering over links */

diff --git a/quartz/components/Head.tsx b/quartz/components/Head.tsx
@@ -14,6 +14,8 @@ export default (() => {
 
     const iconPath = joinSegments(baseDir, "static/icon.png")
     const ogImagePath = `https://${cfg.baseUrl}/static/og-image.png`
+    const manifest =
+      cfg.baseUrl == undefined ? "/manifest.json" : `https://${cfg.baseUrl}/manifest.json`
 
     return (
       <head>
@@ -25,7 +27,9 @@ export default (() => {
         {cfg.baseUrl && <meta property="og:image" content={ogImagePath} />}
         <meta property="og:width" content="1200" />
         <meta property="og:height" content="675" />
+        <meta name="theme-color" content="#faf8f8" />
         <link rel="icon" href={iconPath} />
+        <link rel="manifest" href={manifest} />
         <meta name="description" content={description} />
         <meta name="generator" content="Quartz" />
         <link rel="preconnect" href="https://fonts.googleapis.com" />

diff --git a/quartz/components/pages/OfflineFallbackPage.tsx b/quartz/components/pages/OfflineFallbackPage.tsx
@@ -0,0 +1,12 @@
+import { QuartzComponentConstructor } from "../types"
+
+function OfflineFallbackPage() {
+  return (
+    <article class="popover-hint">
+      <h1>Offline</h1>
+      <p>This page isn't offline available yet.</p>
+    </article>
+  )
+}
+
+export default (() => OfflineFallbackPage) satisfies QuartzComponentConstructor
diff --git a/quartz/plugins/emitters/componentResources.ts b/quartz/plugins/emitters/componentResources.ts
@@ -116,6 +116,11 @@ function addGlobalPageResources(
         document.dispatchEvent(event)`)
   }
 
+  componentResources.afterDOMLoaded.push(`
+  if ('serviceWorker' in navigator) {
+    navigator.serviceWorker.register('/sw.js');
+  }`)
+
   let wsUrl = `ws://localhost:${ctx.argv.wsPort}`
 
   if (ctx.argv.remoteDevHost) {

diff --git a/quartz/plugins/emitters/index.ts b/quartz/plugins/emitters/index.ts
@@ -7,3 +7,4 @@ export { Assets } from "./assets"
 export { Static } from "./static"
 export { ComponentResources } from "./componentResources"
 export { NotFoundPage } from "./404"
+export { Offline } from "./offline"
diff --git a/quartz/plugins/emitters/offline.ts b/quartz/plugins/emitters/offline.ts
@@ -0,0 +1,97 @@
+import { QuartzEmitterPlugin } from "../types"
+import { FilePath, FullSlug } from "../../util/path"
+import { FullPageLayout } from "../../cfg"
+import { sharedPageComponents } from "../../../quartz.layout"
+import OfflineFallbackPage from "../../components/pages/OfflineFallbackPage"
+import BodyConstructor from "../../components/Body"
+import { pageResources, renderPage } from "../../components/renderPage"
+import { defaultProcessedContent } from "../vfile"
+import { QuartzComponentProps } from "../../components/types"
+
+export const Offline: QuartzEmitterPlugin = () => {
+  const opts: FullPageLayout = {
+    ...sharedPageComponents,
+    pageBody: OfflineFallbackPage(),
+    beforeBody: [],
+    left: [],
+    right: [],
+  }
+
+  const { head: Head, pageBody, footer: Footer } = opts
+  const Body = BodyConstructor()
+
+  return {
+    name: "OfflineSupport",
+    getQuartzComponents() {
+      return [Head, Body, pageBody, Footer]
+    },
+    async emit({ cfg }, _content, resources, emit): Promise<FilePath[]> {
+      const manifest = {
+        short_name: cfg.configuration.pageTitle,
+        name: cfg.configuration.pageTitle,
+        description: cfg.configuration.description,
+        background_color: cfg.configuration.theme.colors.lightMode.light,
+        theme_color: cfg.configuration.theme.colors.lightMode.light,
+        display: "minimal-ui",
+        icons: [
+          {
+            src: "static/icon.svg",
+            sizes: "any",
+            purpose: "maskable",
+          },
+          {
+            src: "static/icon.svg",
+            sizes: "any",
+            purpose: "any",
+          },
+        ],
+        start_url:
+          cfg.configuration.baseUrl == undefined ? "/" : `https://${cfg.configuration.baseUrl}/`,
+      }
+
+      const serviceWorker =
+        "importScripts('https://storage.googleapis.com/workbox-cdn/releases/6.4.1/workbox-sw.js');" +
+        "const {pageCache, imageCache, staticResourceCache, googleFontsCache, offlineFallback} = workbox.recipes;" +
+        "pageCache(); googleFontsCache(); staticResourceCache(); imageCache(); offlineFallback();"
+
+      const slug = "offline" as FullSlug
+
+      const url = new URL(`https://${cfg.configuration.baseUrl ?? "example.com"}`)
+      const path = url.pathname as FullSlug
+      const externalResources = pageResources(path, resources)
+      const [tree, vfile] = defaultProcessedContent({
+        slug,
+        text: "Offline",
+        description: "This page isn't offline available yet.",
+        frontmatter: { title: "Offline", tags: [] },
+      })
+
+      const componentData: QuartzComponentProps = {
+        fileData: vfile.data,
+        externalResources,
+        cfg: cfg.configuration,
+        children: [],
+        tree,
+        allFiles: [],
+      }
+
+      return Promise.all([
+        emit({
+          content: JSON.stringify(manifest),
+          slug: "manifest" as FullSlug,
+          ext: ".json",
+        }),
+        emit({
+          content: serviceWorker,
+          slug: "sw" as FullSlug,
+          ext: ".js",
+        }),
+        emit({
+          content: renderPage(slug, componentData, opts, externalResources),
+          slug,
+          ext: ".html",
+        }),
+      ])
+    },
+  }
+}
diff --git a/quartz/static/icon.svg b/quartz/static/icon.svg