mirror of https://github.com/logos-co/roadmap.git
37 lines
1.1 KiB
TypeScript
37 lines
1.1 KiB
TypeScript
import { PluggableList } from "unified"
|
|
import { StaticResources } from "../resources"
|
|
import { ProcessedContent } from "./vfile"
|
|
import { GlobalConfiguration } from "../cfg"
|
|
import { QuartzComponent } from "../components/types"
|
|
|
|
export abstract class QuartzTransformerPlugin {
|
|
abstract name: string
|
|
abstract markdownPlugins(): PluggableList
|
|
abstract htmlPlugins(): PluggableList
|
|
externalResources?: Partial<StaticResources>
|
|
}
|
|
|
|
export abstract class QuartzFilterPlugin {
|
|
abstract name: string
|
|
abstract shouldPublish(content: ProcessedContent): boolean
|
|
}
|
|
|
|
export interface EmitOptions {
|
|
slug: string
|
|
ext: `.${string}`
|
|
content: string
|
|
}
|
|
|
|
export type EmitCallback = (data: EmitOptions) => Promise<string>
|
|
export abstract class QuartzEmitterPlugin {
|
|
abstract name: string
|
|
abstract emit(cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
|
|
abstract getQuartzComponents(): QuartzComponent<any>[]
|
|
}
|
|
|
|
export interface PluginTypes {
|
|
transformers: QuartzTransformerPlugin[],
|
|
filters: QuartzFilterPlugin[],
|
|
emitters: QuartzEmitterPlugin[],
|
|
}
|