Theme and plugins

theme

theme accepts a theme instance returned by a theme definition. A definition owns its styles, settings schema, and presets.

Core validates that the theme is an instance. Unknown settings are resolved through defaults, preset, and explicit settings, and reflected through data-rb-theme, data-rb-mode, data-rb-layout, and data-rb-setting-*.

Declared themes

A theme package exposes a factory. Pass its options and hand the result to theme.

import { rerurateTheme } from "@riebeckite/theme-rerurate";
 
export default defineConfig({
  site: { title: "My site" },
  theme: rerurateTheme({ colorMode: "system", settings: { motion: true } }),
});

Theme-specific options are owned by the theme package, not by Core. See Theme system.

plugins

plugins is an array of plugin instances. false, null, and undefined are dropped, so a boolean can toggle a plugin.

plugins: [
  obsidianMarkdown(),
  enableSearch && search(),
]

Resolution removes disabled inputs, orders enabled plugins by order, and validates capabilities. Two enabled plugins that share a name fail resolution. Each plugin's validateOptions runs while the config is resolved.

Individual plugin options are documented in the plugin guides and the Plugin system.