quartz icon indicating copy to clipboard operation
quartz copied to clipboard

feat: add support for unlisted files

Open harveyives opened this issue 2 months ago • 8 comments

Picking up from https://github.com/jackyzha0/quartz/pull/495, I would like the ability to publish pages without them appearing in the explorer, recent notes section, etc.

This would be useful when sharing for feedback, or simply to have certain documents hidden from the public (providing your repository is private).

By adding an unlisted file pattern, or by adding unlisted:false to the frontmatter, we enable this functionality.

My initial approach involved a filter, however I found the only way it could be achieved was by checking the config in various components.

Open to suggestions, thanks!

harveyives avatar Oct 15 '25 20:10 harveyives

built with Refined Cloudflare Pages Action

âš¡ Cloudflare Pages Deployment

Name Status Preview Last Commit
quartz ✅ Ready (View Log) Visit Preview 50632a06e980d5793590ce3c2b303866d40b74e7

github-actions[bot] avatar Oct 15 '25 20:10 github-actions[bot]

@saberzero1 are you able to take a look?

harveyives avatar Oct 16 '25 06:10 harveyives

Also, could you add the unlistedPatterns to the documentation?

saberzero1 avatar Oct 16 '25 19:10 saberzero1

@saberzero1 Sure thing. I’ve patched the Private Pages docs to include information about Unlisted Pages. Let me know if this was the right choice. I updated the title but didn’t change the file name, in case there are any links or bookmarks we are wary of breaking.

Thanks for the review btw.

harveyives avatar Oct 18 '25 15:10 harveyives

any thoughts @jackyzha0? Would love to get this in 😀

harveyives avatar Oct 26 '25 07:10 harveyives

i cant exclude my folder 00-raw a folder located at the root of my vault

unlistedPatterns: ["00-raw"],

X [ERROR] Legacy octal literals cannot be used in strict mode

quartz.config.ts:23:23:
  23 │     unlistedPatterns: [00-raw],
     ╵                        ~~

TypeScript's "strict" setting was enabled here:

tsconfig.json:8:4:
  8 │     "strict": true,

DeanLemans avatar Nov 12 '25 21:11 DeanLemans

Are you saying the feature does not work for you @DeanLemans?

The typescript error you posted seems unrelated to me.

harveyives avatar Nov 20 '25 07:11 harveyives

Are you able to check this one out again when you have some time @saberzero1 ?

harveyives avatar Dec 07 '25 14:12 harveyives