@quartz-community/unlisted-pages 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.0
+
+### Minor Changes
+
+- 9be2119: `unlisted:` also applies to pages rendered from files that have frontmatter, such as Excalidraw drawings stored as Markdown (`.excalidraw.md`), through Quartz 5.1's `virtualPageHtmlPlugins` (quartz-community/bases-page#11).
+
 ## 1.0.1
 
 ### Patch Changes

package/dist/index.js

@@ -9,12 +9,18 @@ var rehypeUnlisted = () => {
   };
 };
 var UnlistedPages = () => {
-  return {
+  const instance = {
     name: "UnlistedPages",
     htmlPlugins() {
       return [rehypeUnlisted()];
+    },
+    // Pages rendered from files (Quartz 5.1+): a drawing stored as Markdown has frontmatter, and
+    // `unlisted:` there unlists it like a note (quartz-community/bases-page#11).
+    virtualPageHtmlPlugins() {
+      return [rehypeUnlisted()];
     }
   };
+  return instance;
 };
 
 export { UnlistedPages };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/transformer.ts"],"names":[],"mappings":";AAKA,IAAM,iBAAiB,MAA4B;AACjD,EAAA,OAAO,MAAM,CAAC,KAAA,EAAiB,IAAA,KAAgB;AAC7C,IAAA,MAAM,WAAA,GAAc,KAAK,IAAA,EAAM,WAAA;AAC/B,IAAA,MAAM,WAAW,WAAA,EAAa,QAAA;AAC9B,IAAA,IAAI,OAAO,aAAa,SAAA,EAAW;AACjC,MAAC,IAAA,CAAK,KAAiC,QAAA,GAAW,QAAA;AAAA,IACpD;AAAA,EACF,CAAA;AACF,CAAA;AAEO,IAAM,gBAAoD,MAAM;AACrE,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,eAAA;AAAA,IACN,WAAA,GAA6B;AAC3B,MAAA,OAAO,CAAC,gBAAgB,CAAA;AAAA,IAC1B;AAAA,GACF;AACF","file":"index.js","sourcesContent":["import type { PluggableList, Plugin } from \"unified\";\nimport type { Root as HastRoot } from \"hast\";\nimport type { VFile } from \"vfile\";\nimport type { QuartzTransformerPlugin } from \"@quartz-community/types\";\n\nconst rehypeUnlisted = (): Plugin<[], HastRoot> => {\n  return () => (_tree: HastRoot, file: VFile) => {\n    const frontmatter = file.data?.frontmatter as Record<string, unknown> | undefined;\n    const unlisted = frontmatter?.unlisted;\n    if (typeof unlisted === \"boolean\") {\n      (file.data as Record<string, unknown>).unlisted = unlisted;\n    }\n  };\n};\n\nexport const UnlistedPages: QuartzTransformerPlugin<undefined> = () => {\n  return {\n    name: \"UnlistedPages\",\n    htmlPlugins(): PluggableList {\n      return [rehypeUnlisted()];\n    },\n  };\n};\n"]}
+{"version":3,"sources":["../src/transformer.ts"],"names":[],"mappings":";AAKA,IAAM,iBAAiB,MAA4B;AACjD,EAAA,OAAO,MAAM,CAAC,KAAA,EAAiB,IAAA,KAAgB;AAC7C,IAAA,MAAM,WAAA,GAAc,KAAK,IAAA,EAAM,WAAA;AAC/B,IAAA,MAAM,WAAW,WAAA,EAAa,QAAA;AAC9B,IAAA,IAAI,OAAO,aAAa,SAAA,EAAW;AACjC,MAAC,IAAA,CAAK,KAAiC,QAAA,GAAW,QAAA;AAAA,IACpD;AAAA,EACF,CAAA;AACF,CAAA;AAEO,IAAM,gBAAoD,MAAM;AAErE,EAAA,MAAM,QAAA,GAEF;AAAA,IACF,IAAA,EAAM,eAAA;AAAA,IACN,WAAA,GAA6B;AAC3B,MAAA,OAAO,CAAC,gBAAgB,CAAA;AAAA,IAC1B,CAAA;AAAA;AAAA;AAAA,IAGA,sBAAA,GAAwC;AACtC,MAAA,OAAO,CAAC,gBAAgB,CAAA;AAAA,IAC1B;AAAA,GACF;AACA,EAAA,OAAO,QAAA;AACT","file":"index.js","sourcesContent":["import type { PluggableList, Plugin } from \"unified\";\nimport type { Root as HastRoot } from \"hast\";\nimport type { VFile } from \"vfile\";\nimport type { QuartzTransformerPlugin } from \"@quartz-community/types\";\n\nconst rehypeUnlisted = (): Plugin<[], HastRoot> => {\n  return () => (_tree: HastRoot, file: VFile) => {\n    const frontmatter = file.data?.frontmatter as Record<string, unknown> | undefined;\n    const unlisted = frontmatter?.unlisted;\n    if (typeof unlisted === \"boolean\") {\n      (file.data as Record<string, unknown>).unlisted = unlisted;\n    }\n  };\n};\n\nexport const UnlistedPages: QuartzTransformerPlugin<undefined> = () => {\n  // a variable, not a literal: `virtualPageHtmlPlugins` is newer than the declared types\n  const instance: ReturnType<QuartzTransformerPlugin> & {\n    virtualPageHtmlPlugins(): PluggableList;\n  } = {\n    name: \"UnlistedPages\",\n    htmlPlugins(): PluggableList {\n      return [rehypeUnlisted()];\n    },\n    // Pages rendered from files (Quartz 5.1+): a drawing stored as Markdown has frontmatter, and\n    // `unlisted:` there unlists it like a note (quartz-community/bases-page#11).\n    virtualPageHtmlPlugins(): PluggableList {\n      return [rehypeUnlisted()];\n    },\n  };\n  return instance;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quartz-community/unlisted-pages",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Bridges `frontmatter.unlisted` to `file.data.unlisted` so any page can opt out of discovery surfaces (contentIndex, RSS, sitemap, graph, explorer, search, backlinks, recent-notes, folder-page, tag-page) while remaining accessible by direct URL.",
   "type": "module",
   "license": "MIT",
@@ -61,10 +61,10 @@
     }
   },
   "dependencies": {
-    "@quartz-community/types": "^1.0.0",
-    "@quartz-community/utils": "^1.0.0"
+    "@quartz-community/types": "^1.0.0"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.29.2",
     "@types/hast": "^3.0.4",
     "@types/node": "^24.10.0",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
@@ -76,8 +76,7 @@
     "typescript": "^5.9.3",
     "unified": "^11.0.5",
     "vfile": "^6.0.3",
-    "vitest": "^2.1.9",
-    "@changesets/cli": "^2.29.2"
+    "vitest": "^2.1.9"
   },
   "quartz": {
     "name": "unlisted-pages",