Universal renderer

Render various diagrams and generate dynamic svgs in Obsidian. (Similar to Obsidian kroki)

[!Note] This plugin uses system packages for diagram rendering (js ports are slow, I wanted something native)

Supported diagrams

Special diagrams

Installation

From the community store

Just search for 'Universal renderer' in the obsidian community plugins

From the releases

• Copy over main.js, styles.css, manifest.json to your vault <VaultFolder>/.obsidian/plugins/universal-renderer/ from the releases section

Manually

• Clone this repository
• npm i or yarn to install dependencies
• npm run build
• Copy over main.js, styles.css, manifest.json to your vault <VaultFolder>/.obsidian/plugins/universal-renderer/.
• Install graphviz, latex, mermaid-cli, gnuplot, plantuml, typst, etc... via your system package manager (you can customize executable file locations in plugin settings)

Via BRAT

• Install the BRAT plugin via Community Plugin Search
• Read the docs
• Add https://github.com/dgudim/obsidian-universal-renderer

Usage

• Create a fenced codeblock using one of the diagram types supported by renderer as the language (See a list of supported diagrams)
• Use graph parameters to customize the appearance of the graph
• Specify your diagram code inside the codeblock

Customizing diagram colors

1. Open palattegen.ts
2. Modify colors and shades constants to your liking (default theme is gruvbox)
3. Rebuild the plugin
4. Delete styles.css
5. Reenable the plugin/restart obsidian 2 times

Graph parameters

Various parameters can be specified before the diagram code similar to obsidian's frontmatter

Available parameters

Example

```
---
invert-shade:1
width:90%
text-fill:keep-shade
---
<diagram code>
```

Color mixing

When a diagram uses a color that isn't part of your theme, the renderer finds the closest theme color and replaces it. By default the original color is fully replaced, but you can use mix-multiplier to bring some of the original color back, and mix-mode controls how it is done.

At mix-multiplier = 0 both modes produce the pure theme color. delta preserves the theme while carrying over the source's relative tint, mix fades theme color to the source color.

```dot
---
mix-multiplier:0.5
mix-mode:delta
---
<diagram code>
```

Presets

By default there is 1 explicit preset defined

There are also presets which are applied by default

Defining a preset

1. open processors.ts
2. Modify presets constant to your liking, presets can contain any graph parameters
3. Rebuild the plugin

[!Note] Presets starting with default-<diagram type> will be applied by default to that diagram type

Refgraph

A special diagram type, usefull for reducing code duplication, just displays an already rendered graph

Syntax is as follows:

```refgraph
<graph name>
```

Graph name is set by a name/ref-name/graph-name parameter (See graph parameters)

Dynamic svg

This is not even a graph, the aim of this codeblock is to make your svgs follow the defined color scheme (For example you have a black svg and it looks bad in dark theme)

Syntax and example:

```dynamic-svg
---
invert-shade
width:100%
---
[[file name]]
```

Here we take some svg, make it follow the color scheme (See customizing diagram colors) and invert it's shades (black to white, etc.)

[!Note] This doesn't work well for non-optimized large svgs or with complex svgs