Skip to main content

Interface: DbmlThemeConfig

themeConfig.dbml in docusaurus.config: site-wide defaults for every diagram.

Example​

// docusaurus.config.ts
export default {
plugins: ['@relvista/docusaurus-plugin'],
themeConfig: {
dbml: {
height: 560,
detailLevel: 'keys',
toolbar: ['search', 'zoom', 'fit', 'fullscreen', 'export'],
editorUrl: false,
},
},
};

Properties​

detailLevel​

detailLevel: DetailLevel;

Default detail level: every column, keys only, or table names only. Default all.


editorUrl​

editorUrl: string | false;

Base URL of the relvista editor for the "Open in editor" button. Defaults to the hosted editor (DEFAULT_EDITOR_URL); false hides the button.


height​

height: string | number;

Default viewer height (number = px, or any CSS length). Default 480.


palette​

palette: DbmlPalette;

Diagram colours. site (default): the site's Infima colours and fonts (primary colour for table headers and highlights, surfaces, text), in light and dark mode. relvista: relvista's own palette, as in the editor. Colours set in the DBML (headercolor, group and note colours) and --rv-* variables in the site's CSS win in both.


ssr​

ssr: boolean;

Draw every diagram into the page's HTML at build time (a static SVG, shown without JavaScript, before it loads, in print and to search engines), which the interactive viewer then replaces in place. Default true; ssr={false} / fence meta ssr=false turns it off for one diagram.


toolbar​

toolbar: ToolbarItem[];

Toolbar buttons, in order. Default: every button.