Plugins and themes

Plugins are passed through plugins:

plugins: [
  obsidianMarkdown(),
  media(),
  attachment(),
]

You can also switch plugins conditionally. PluginInput treats

false
null
undefined

as disabled plugin inputs. For example, conditional configuration such as

plugins: [
  enableAnalytics && analytics(),
]

is possible. During config resolution, disabled inputs are discarded, enabled plugins are ordered stably, and capability consistency is then checked.

Configuration errors are reported as ConfigValidationError; do not catch and hide them. Run riebeckite check after changes. Continue with Plugin system or Theme system for their option contracts.

History

1 changesCollapseExpand

From To

	1	`+ ---`
	2	`+ title: Plugin configuration`
	3	`+ sidebar:`
	4	`+ label: Plugin configuration`
	5	`+ order: 60`
	6	`+ ---`
	7	`+`
	8	`+ # Plugins and themes`
	9	`+`
	10	+ Plugins are passed through `plugins`:
	11	`+`
	12	+ ```ts
	13	`+ plugins: [`
	14	`+ obsidianMarkdown(),`
	15	`+ media(),`
	16	`+ attachment(),`
	17	`+ ]`
	18	+ ```
	19	`+`
	20	+ You can also switch plugins conditionally. `PluginInput` treats
	21	`+`
	22	+ ```text
	23	`+ false`
	24	`+ null`
	25	`+ undefined`
	26	+ ```
	27	`+`
	28	`+ as disabled plugin inputs. For example, conditional configuration such as`
	29	`+`
	30	+ ```ts
	31	`+ plugins: [`
	32	`+ enableAnalytics && analytics(),`
	33	`+ ]`
	34	+ ```
	35	`+`
	36	`+ is possible. During config resolution, disabled inputs are discarded, enabled plugins are ordered stably, and capability consistency is then checked.`
	37	`+`
	38	+ Configuration errors are reported as `ConfigValidationError`; do not catch and hide them. Run `riebeckite check` after changes. Continue with [Plugin system](../plugin-api.md) or [Theme system](../theme-api.md) for their option contracts.
	39	`+`