quartz-community/types
1
0
Fork 0
mirror of https://github.com/quartz-community/types.git synced 2026-07-22 02:50:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
15 commits 1 branch 0 tags 114 KiB
TypeScript 100%
Find a file
saberzero1 c7df97d0de
feat: add TreeTransform type and treeTransforms field to PageType plugin 
Add TreeTransform type for render-time HAST tree mutations, enabling
pageType plugins to register tree walkers that run after transclusion
when allFiles data is available. Used by bases-page for inline
```base codeblock support.
2026-03-07 22:12:08 +01:00
src feat: add TreeTransform type and treeTransforms field to PageType plugin 2026-03-07 22:12:08 +01:00
.gitignore Initial commit 2026-02-07 20:31:27 +01:00
LICENSE Initial commit 2026-02-07 20:31:27 +01:00
package-lock.json Fix type compatibility: use flat GlobalConfiguration, remove preact dependency 2026-02-13 13:49:21 +01:00
package.json fix: move tsup and typescript to dependencies for git install compatibility 2026-02-22 22:05:30 +01:00
README.md Initial implementation of @quartz-community/types package 2026-02-07 20:39:05 +01:00
tsconfig.json Consolidate all types into single index.ts with proper exports 2026-02-13 13:18:01 +01:00
tsup.config.ts Initial implementation of @quartz-community/types package 2026-02-07 20:39:05 +01:00

README.md

@quartz-community/types

Type definitions for Quartz community plugins. This package provides TypeScript interfaces and types that mirror the internal Quartz types, enabling external plugins to have full type safety without depending on the core Quartz package.

Installation

npm install @quartz-community/types

Usage

import {
  QuartzComponent,
  QuartzComponentProps,
  ExplorerOptions,
} from "@quartz-community/types";

const MyComponent: QuartzComponent = (props: QuartzComponentProps) => {
  // Component implementation
};

MyComponent.css = `
  .my-component { /* styles */ }
`;

MyComponent.afterDOMLoaded = `
  // Client-side script
`;

Included Types

  • Component Types: QuartzComponent, QuartzComponentProps, StringResource
  • Plugin Types: QuartzTransformerPlugin, QuartzFilterPlugin, QuartzEmitterPlugin
  • Data Types: FileTrieNode, ContentIndex, ContentIndexEntry
  • Component Options: ExplorerOptions, GraphOptions, SearchOptions, D3Config
  • Utility Types: HTMLAttributes, EventHandler, CleanupFunction, ClassValue

License

MIT