Replace per-plugin npm install with a single aggregated npm install
in the quartz root. Plugins declaring requiresInstall in their quartz
manifest now have their peerDependencies collected and installed
together, letting npm resolve compatible versions across plugins.
Remove dependencies that are only used by plugins and already bundled
into their dist files via devDependencies/tsup. This reduces the
install footprint by ~136 packages.
Removed: flexsearch, github-slugger (kept - needed by @quartz-community/utils),
gray-matter, hast-util-to-html, hast-util-to-string, is-absolute-url,
js-yaml, mdast-util-find-and-replace, mdast-util-to-hast,
mdast-util-to-string, reading-time, rehype-autolink-headings,
rehype-citation, rehype-katex, rehype-mathjax, rehype-pretty-code,
rehype-raw, rehype-slug, remark-breaks, remark-frontmatter,
remark-gfm, remark-math, remark-smartypants, satori, toml,
@types/js-yaml.
Kept native-binary deps: sharp, @napi-rs/simple-git,
@myriaddreamin/rehype-typst (cannot be bundled by plugins).
Add logOverride to the main esbuild build context to silence three
warning types that originate from upstream third-party code bundled
inside plugin dist files:
- direct-eval: gray-matter's JS frontmatter engine in note-properties
- equals-negative-zero: webidl-conversions in citations
- duplicate-object-key: BibTeX month mapping in citations
- validatePluginExternals() scans plugin dist/ for unbundled imports
and warns when non-allowlisted externals are detected
- installPluginDepsIfNeeded() runs npm install for plugins with
quartz.requiresInstall flag (for native deps like sharp)
- Added requiresInstall field to PluginManifest type
- Removed frontmatter from description plugin's vfile augmentation to avoid
conflicting DataMap declarations (TS2717/TS2687)
- Aligned frontmatter type in index.ts with note-properties plugin declaration
- Updated quartz.lock.json for description plugin
- Use --ignore-scripts during npm install to prevent duplicate builds
- Skip build entirely when dist/ directory already exists (pre-built plugins)
- Add buildPluginAsync() and runParallel() for concurrent plugin builds
- Convert all 5 build loops to parallel execution bounded by CPU count
- Prune devDependencies after build to avoid singleton duplication
Extend linkPeerPlugins() to handle two cases after pruning devDependencies:
1. @quartz-community/* peers → symlink to sibling plugin (existing)
2. All other peers → symlink to host Quartz node_modules (new)
Combined with the plugin-side changes (build tools moved to devDependencies,
shared runtime deps moved to peerDependencies), this reduces per-plugin
node_modules from ~59MB to ~6.7MB — an ~89% reduction (~2.2GB total savings
across 42 plugins).
* feat(plugins): v5 plugin system
* feat(plugins): explorer as community plugin
* feat(plugins): graph as community plugin
* chore: update package-lock.json
* chore: update package-lock.json
* docs: updated plugin-specific docs
* chore: update package-lock.json
* chore: update package-lock.json
* chore: update package-lock.json
* Implement Git-based plugin system with dogfooding for community plugins
- Remove npm dependencies for @quartz-community/* plugins
- Add gitLoader.ts for installing plugins from GitHub
- Update quartz.layout.ts to import from .quartz/plugins/
- Add install-plugins.ts script for prebuild hook
- Add .quartz/ to .gitignore
* Add comprehensive Git-based plugin CLI with lockfile support
- Create quartz.lock.json format for tracking exact plugin commits
- Add 'npx quartz plugin' commands: install, add, remove, update, list, restore
- Plugin state is fully reproducible via lockfile
- No npm dependencies required for community plugins
* Fix TypeScript errors in git-installed plugins
- Install @quartz-community/types as devDependency
- Fix plugin imports to define types locally
- Fix search inline script fetchData bug
- Format code with prettier
* fix(types): install types from github
* docs: updated plugin-specific docs
* Update Dockerfile and add CI/CD documentation
- Add plugin install step to Dockerfile
- Create docs/ci-cd.md with pipeline configuration guide
* Update GitHub Actions workflows for v5 branch and Git-based plugins
- Change branch references from v4 to v5
- Add plugin caching to speed up builds
- Use 'npx quartz plugin install' instead of 'restore'
- Update Docker workflow branch trigger
* Update quartz.lock.json with fixed plugin versions
* fix(docker): install command
* docs: add plugin migration analysis document
Comprehensive analysis of which Quartz v4 components and plugins
can be migrated to separate repositories, including:
- Component analysis (25 components)
- Plugin analysis (transformers, emitters, filters)
- Migration strategies for different plugin types
- Lessons learned from Explorer/Graph/Search migrations
- Recommended migration order
* chore: updated plugins
* chore: updated plugins
* chore: updated dependencies
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: tsconfig
* feat: build installed plugins
* chore: updated plugins
* chore: updated plugins
* chore: update explorer plugin with duplication fix
* docs: Quartz v5
* chore: update graph plugin with navigation fix
* fix: update explorer plugin with toggle fix
* fix: update explorer plugin - ensure toggle buttons always work
* fix: create plugin components once to prevent duplicate script registration
* chore: updated plugins
* chore: updated plugins
* feat: migrate 7 feature components to community plugins (Phase B)
Migrate ArticleTitle, TagList, PageTitle, Darkmode, ReaderMode,
ContentMeta, and Footer from internal components to community
plugins. Update layout to use Plugin.X() pattern, remove internal
component files and their styles/scripts.
Add MIGRATION_TASKS.md documenting the full migration roadmap.
* chore: updated plugins
* refactor: delete 6 internal component duplicates (Phase A)
Remove Backlinks, Breadcrumbs, RecentNotes, Search, TableOfContents,
Comments, and OverflowList — all replaced by community plugins.
Delete associated styles (6) and scripts (3). Switch layout to use
Plugin.Breadcrumbs() instead of Component.Breadcrumbs().
* refactor: unify QuartzComponent type to structural interface (Phase C)
- Changed QuartzComponent from ComponentType<QuartzComponentProps> to callable type ((props: QuartzComponentProps) => any)
- Added optional displayName property for better debugging
- Removed ComponentType import from preact
- Removed all 13 'as QuartzComponent' type casts from quartz.layout.ts
- Community plugin components now directly assignable without casts
* feat: add PageType plugin infrastructure (Phase D Step 4)
* feat: add PageTypePluginEntry for cross-boundary type compatibility
Introduce PageTypePluginEntry with never[] parameter types to accept
both internal and community PageType plugins in config arrays without
casts, working around branded FullSlug contravariance mismatch.
* refactor: update dispatcher to cast PageTypePluginEntry at boundary
Add getPageTypes() helper that casts config's PageTypePluginEntry[]
to QuartzPageTypePluginInstance[] in one place. Cast VirtualPage.slug
to FullSlug at emitPage/defaultProcessedContent call sites.
* feat: integrate community PageType plugins (Phase D Step 6)
Replace old page-rendering emitters with PageTypeDispatcher emitter
and pageTypes array. Restructure quartz.layout.ts from three separate
exports to unified layout object with defaults and byPageType record.
Install content-page, folder-page, tag-page community plugins.
* refactor: delete old page-rendering emitters
Remove ContentPage, FolderPage, TagPage, and NotFoundPage emitters
now replaced by community PageType plugins and the PageTypeDispatcher.
* refactor: remove migrated page body components
Delete Content, FolderContent, TagContent page components now provided
by community PageType plugins. Update components barrel export.
* fix: update lockfile to fixed folder-page and tag-page commits
Points to commits that remove duplicate PageList/SortFn re-exports,
fixing TS2300 duplicate identifier errors in generated plugin index.
* chore: updated plugins
* fix: populate ctx.trie in PageTypeDispatcher before rendering
Components like FolderContent depend on ctx.trie for folder hierarchy.
The dispatcher now lazily initializes it via trieFromAllFiles in emit
and force-rebuilds it in partialEmit to reflect file changes.
* chore: update lockfile to fixed folder-page commit
* chore: updated plugins
* chore: update explorer plugin to fix SPA folder navigation
* feat: extract transformers to community plugins and fix type compatibility
- Delete 12 internal transformer files (keep FrontMatter as internal)
- Switch quartz.config.ts to use ExternalPlugin.* for all transformers
- Align branded types with @quartz-community/types (_brand, FullSlug etc.)
- Add vfile DataMap augmentations for fields from extracted transformers
- Update all 29 plugins to @quartz-community/types v0.2.1
* Migrate filters to external plugins (remove-draft, explicit-publish)
Delete internal RemoveDrafts and ExplicitPublish filter implementations,
install them as community plugins, and update quartz.config.ts to use
ExternalPlugin.RemoveDrafts().
* Migrate emitters to external plugins (alias-redirects, cname, favicon, content-index, og-image)
* refactor: remove inline scripts/styles migrated to plugins
Delete dead code: callout, checkbox, mermaid inline scripts and styles
are now bundled by the obsidian-flavored-markdown plugin. Clipboard
script and styles moved to the syntax-highlighting plugin. listPage.scss
was unreferenced. Body.tsx simplified to a pure layout wrapper.
* refactor: consolidate utils to re-export from @quartz-community/utils
* fix: use dangerouslySetInnerHTML for inline CSS to prevent HTML-escaping
Preact was escaping & characters in SCSS-compiled CSS (e.g. & nesting)
into &, breaking CSS rules. Using dangerouslySetInnerHTML bypasses
the escaping, matching how browsers expect style element content.
* chore: update plugins with inline script transpilation fix
* chore: updated plugins
* docs: update plugin API sections for v5 community plugins
* docs: rewrite documentation for v5 plugin system
Update feature docs, hosting, CI/CD, getting started, configuration,
layout, architecture, creating components, making plugins, and
migration guide to reflect the v5 community plugin architecture.
* docs: fix outdated v4 references in documentation
* chore: remove completed migration planning docs
* chore: updated plugins
* chore: cleanup
* chore: cleanup
* chore: bump version to 5.0.0
* chore: updated dependencies
* feat: integrate CanvasPage plugin with types, assets, config, layout, and documentation
* chore: updated dependencies
* chore: updated dependencies
* chore: updated linter
* chore: update canvas-page plugin to c942fcb
* chore: updated plugins
* chore: update canvas-page plugin to f88f1b9
* chore: updated plugins
* chore: update canvas-page plugin to 079304c
* chore: updated plugins
* chore: canvas layout
* chore: update canvas-page plugin to 38d49e1
* chore: updated plugins
* chore: update canvas-page plugin to 505c099
* chore: updated plugins
* chore: updated plugins
* fix: Obsidian flavored markdown
* fix: Obsidian flavored markdown
* fix: Obsidian flavored markdown
* chore: cleanup
* chore: updated plugins
* feat: configuration files
* feat: Quartz TUI
* feat(tui): YAML configuration
* chore: tsup
* chore: tsup
* feat: support array categories in plugin manifests
Plugins like note-properties export both transformer and component
functionality. Allow PluginManifest.category to be a single value
or an array, with config-loader resolving to the first processing
category (transformer/filter/emitter/pageType) for dispatch.
* refactor: remove built-in FrontMatter transformer
Frontmatter processing is now handled by the note-properties plugin,
which provides the same YAML/TOML parsing plus link extraction and
a visual properties panel. The built-in transformer is no longer needed.
* feat: add note-properties plugin to default configuration
Register note-properties as the first plugin (order 5) in both
the user config and the default config. Placed in beforeBody layout
zone with priority 15 (between article-title at 10 and content-meta at 20).
* docs: add plugin management strategy and syncer v5 notes
Document the plugin management system design decisions and provide
implementation guidance for the Quartz Syncer v5 integration.
* feat: add bases-page plugin to default configuration
Enable Obsidian Bases (.base) file support with bases page type
and layout entry in both user and default config.
* docs: update syncer notes with bases-page, note-properties, and spacer
Add all three new plugins to the quick reference table (40 total).
Add content, canvas, and bases page types to byPageType documentation.
* chore: updated plugins
* fix: update CI to Node 24 and regenerate lockfiles for clean install
* fix: resolve type errors for CI checks
* chore: updated plugins
* chore: updated plugins
* fix: plugin mapping from configuration
* fix: CI
* fix: CI
* docs: rewrite Frontmatter documentation for note-properties plugin
* chore: updated plugins
* docs: Quartz v5
* chore: updated plugins
* chore: updated plugins
* refactor: extract TUI to standalone plugin repository
* chore: linting
* docs: Quartz v5
* feat: update and upgrade commands
* chore: updated plugins
* chore: updated plugins
* chore: cleanup
* chore: cleanup
* chore: cleanup
* chore: cleanup
* chore: cleanup
* fix: layout group priority
* fix: view classes
* fix: include virtual pages in content index for explorer visibility
* docs: add board, gallery, and cards view examples to navigation page
* chore: updated plugins
* fix: include virtualPages in worker serializable build context
* fix: set relativePath on virtual pages to prevent explorer crash
* fix: exclude 404
* fix(links): virtual page links
* fix(links): virtual page transclusion
* docs: architecture overview
* fix: only call scripts one per page
* fix: type error in component registry instantiate method
* fix: left layout order
* fix(layout): remove tag-list by default
* docs(plugins): updated plugin list defaults
* fix(layout): priorities
* feat: add PageFrame system for custom page layouts
* feat: integrate PageFrame into rendering pipeline
* feat: add frame resolution to page type dispatcher and config loader
* style: add CSS grid overrides for full-width and minimal page frames
* feat: set minimal frame for 404 and update canvas-page plugin
* docs: add PageFrame system to architecture overview
* fix: wrap frame.render() in array to satisfy Body children type
* chore: format
* fix: use absolute asset paths for 404 page so it works in subdirectories
* fix(layout): priorities
* docs: page frames
* feat: add FrameRegistry for plugin-provided page frames
Plugins can now register custom page frames via their manifest's
'frames' field. Frames are loaded alongside components during plugin
initialization and resolved by name at render time with fallback
to built-in frames.
* feat(layout): page frames
* fix(layout): linting
* fix: inject frame CSS into page so plugin-provided frames render correctly
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* docs: canvas
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* feat: add TreeTransform hook, fix multi-category plugins, and resolve cross-plugin dependencies
- Add TreeTransform type and treeTransforms hook to pageType plugins, enabling
render-time HAST tree mutations (e.g. bases-page inline codeblock resolution)
- Fix config-loader to push multi-category plugins into ALL matching processing
buckets instead of only the first match
- Add side-effect import for component-only plugins so view registrations
(e.g. leaflet-map via globalThis ViewRegistry) execute at load time
- Add npm prune --omit=dev and cross-plugin peer dependency symlinking to
buildPlugin() to prevent duplicate-singleton issues from nested node_modules
* chore: format
* chore: test docs
* chore: updated plugins
* fix: prevent HTML-escaping of inline style and script content in htmlToJsx
Add dangerouslySetInnerHTML overrides for <style> and <script> elements
so that CSS/JS injected by tree transforms is not HTML-escaped during
preact-render-to-string serialization.
* chore: update plugin lockfile for htmlToJsx migration
* chore: update leaflet-map plugin (fix deferred L.Control)
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: updated plugins
* chore: test npx quartz upgrade
* feat(templates): add obsidian, ttrpg, blog templates
* docs: move bases
* docs: removed leaflet demo
* feat(cli): configure baseUrl during create
* docs: updated cli commands
* docs: updated documentation for v5
* feat(cli): prune and resolve
* chore: rebuild lockfile
* docs: cli documentation
* docs: plugin development and setup guide
* chore: deleted redundant files
* fix(build): fallback config
* chore: updated lockfile
* docs: removed outdated v3 setup
* feat(cli): allow non-default branch plugins
* docs: install branch commands
* feat(cli): allow local plugins
* docs: install local commands
* feat: add render event type and listener for in-place DOM re-initialization
* docs: add EncryptedPages plugin documentation
* docs: add encrypted pages live demo page
- New password-protected demo page (password: quartz) showing the plugin in action
- Link to demo from EncryptedPages plugin page with password hint callout
* feat: add encrypted-pages plugin to all templates
- Enabled by default in default, obsidian, and ttrpg templates
- Disabled by default in blog template
* chore: updated plugins
* chore: updated layouts
* chore: updated plugins
* feat: stacked pages
* feat: added stacked page panes
* docs: touch-ups
* Fix language parameter of the citation plugin for non en-US settings
Per default the rehype-citation project only supports en-US, as
explained here: https://github.com/timlrx/rehype-citation/issues/12
For other languages one can provide a locale-file either by passing
its path or providing an URL. The following repository contains locale
files for multiple languages. So, these are used, in case a non en-US
language is used in quarzt. But this optimistically assumes there is
indeed an according locale file.
In summary this solves the problem only partially, since there are
still some languages which will not work properly.
* Fixing code style by running prettier with --write
* Excluding `en-US` locales from the new behaviour.
* Removing unnecessary `null` und `undefined` check.
* Update quartz/plugins/transformers/citations.ts
* Update quartz/plugins/transformers/citations.ts
* Update quartz/plugins/transformers/citations.ts
---------
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
This makes it so that the events are not fired until the file have stabilized.
This also changes the order of the fired events.
A move / rename now results in `delete` then `add` rather than the other way around.
From `chokidar` README - https://github.com/paulmillr/chokidar?tab=readme-ov-file#performance:
```
awaitWriteFinish.stabilityThreshold (default: 2000). Amount of time in milliseconds for a file size to remain constant before emitting its event.
```
Fixes#2232
