mirror of
https://github.com/quartz-community/graph.git
synced 2026-07-22 02:50:25 +00:00
68ce4d4c8a
Pre-built output is now committed to the repository so that Quartz can skip the build step during plugin installation. The prepare script is removed to prevent redundant builds when installing from npm/git.
42 lines
1.9 KiB
TypeScript
42 lines
1.9 KiB
TypeScript
export { BuildCtx, CSSResource, ChangeEvent, JSResource, ProcessedContent, QuartzEmitterPlugin, QuartzEmitterPluginInstance, QuartzFilterPlugin, QuartzFilterPluginInstance, QuartzPluginData, QuartzTransformerPlugin, QuartzTransformerPluginInstance, StaticResources } from '@quartz-community/types';
|
|
|
|
interface ExampleTransformerOptions {
|
|
/** Token used to highlight text, defaults to ==highlight== */
|
|
highlightToken: string;
|
|
/** Add a CSS class to all headings in the rendered HTML. */
|
|
headingClass: string;
|
|
/** Enable remark-gfm for tables/task lists. */
|
|
enableGfm: boolean;
|
|
/** Enable adding slug IDs to headings. */
|
|
addHeadingSlugs: boolean;
|
|
}
|
|
interface ExampleFilterOptions {
|
|
/** Allow pages marked draft: true to publish. */
|
|
allowDrafts: boolean;
|
|
/** Exclude pages that contain any of these frontmatter tags. */
|
|
excludeTags: string[];
|
|
/** Exclude paths that start with any of these prefixes (relative to content root). */
|
|
excludePathPrefixes: string[];
|
|
}
|
|
interface ExampleEmitterOptions {
|
|
/** Filename to emit at the site root. */
|
|
manifestSlug: string;
|
|
/** Whether to include the frontmatter block in the manifest. */
|
|
includeFrontmatter: boolean;
|
|
/** Extra metadata to write at the top level of the manifest. */
|
|
metadata: Record<string, unknown>;
|
|
/** Optional hook to transform the emitted manifest JSON string. */
|
|
transformManifest?: (json: string) => string;
|
|
/** Add a custom class to the emitted manifest <script> tag if used in HTML. */
|
|
manifestScriptClass?: string;
|
|
}
|
|
interface ExampleComponentOptions {
|
|
/** Text to prefix before the title */
|
|
prefix?: string;
|
|
/** Text to suffix after the title */
|
|
suffix?: string;
|
|
/** CSS class name to apply */
|
|
className?: string;
|
|
}
|
|
|
|
export type { ExampleComponentOptions, ExampleEmitterOptions, ExampleFilterOptions, ExampleTransformerOptions };
|