scapegoat/Docs2.git

			@@ -25,10 +25,11 @@
			- `BuildCtx` is defined in `quartz/ctx.ts`. It consists of
			- `argv`: The command line arguments passed to the Quartz [[build]] command
			- `cfg`: The full Quartz [[configuration]]
			- `allSlugs`: a list of all the valid content slugs (see [[paths]] for more information on what a `ServerSlug` is)
			- `allSlugs`: a list of all the valid content slugs (see [[paths]] for more information on what a slug is)
			- `StaticResources` is defined in `quartz/resources.tsx`. It consists of
			- `css`: a list of CSS style definitions that should be loaded. A CSS style is described with the `CSSResource` type which is also defined in `quartz/resources.tsx`. It accepts either a source URL or the inline content of the stylesheet.
			- `js`: a list of scripts that should be loaded. A script is described with the `JSResource` type which is also defined in `quartz/resources.tsx`. It allows you to define a load time (either before or after the DOM has been loaded), whether it should be a module, and either the source URL or the inline content of the script.
			- `additionalHead`: a list of JSX elements or functions that return JSX elements to be added to the `<head>` tag of the page. Functions receive the page's data as an argument and can conditionally render elements.

			## Transformers

			@@ -220,12 +221,26 @@

			export type QuartzEmitterPluginInstance = {
			name: string
			emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise<FilePath[]>
			emit(
			ctx: BuildCtx,
			content: ProcessedContent[],
			resources: StaticResources,
			): Promise<FilePath[]> \| AsyncGenerator<FilePath>
			partialEmit?(
			ctx: BuildCtx,
			content: ProcessedContent[],
			resources: StaticResources,
			changeEvents: ChangeEvent[],
			): Promise<FilePath[]> \| AsyncGenerator<FilePath> \| null
			getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
			}
			```

			An emitter plugin must define a `name` field, an `emit` function, and a `getQuartzComponents` function. `emit` is responsible for looking at all the parsed and filtered content and then appropriately creating files and returning a list of paths to files the plugin created.
			An emitter plugin must define a `name` field, an `emit` function, and a `getQuartzComponents` function. It can optionally implement a `partialEmit` function for incremental builds.

			- `emit` is responsible for looking at all the parsed and filtered content and then appropriately creating files and returning a list of paths to files the plugin created.
			- `partialEmit` is an optional function that enables incremental builds. It receives information about which files have changed (`changeEvents`) and can selectively rebuild only the necessary files. This is useful for optimizing build times in development mode. If `partialEmit` is undefined, it will default to the `emit` function.
			- `getQuartzComponents` declares which Quartz components the emitter uses to construct its pages.

			Creating new files can be done via regular Node [fs module](https://nodejs.org/api/fs.html) (i.e. `fs.cp` or `fs.writeFile`) or via the `write` function in `quartz/plugins/emitters/helpers.ts` if you are creating files that contain text. `write` has the following signature:

			@@ -234,7 +249,7 @@
			// the build context
			ctx: BuildCtx
			// the name of the file to emit (not including the file extension)
			slug: ServerSlug
			slug: FullSlug
			// the file extension
			ext: `.${string}` \| ""
			// the file content to add