Obsidian 插件:【Readme】Universal renderer

Obsidian 插件:【Readme】Universal renderer

插件名片

  • 插件名称:Universal renderer
  • 插件作者:Kloud
  • 插件说明:使用系统原生包来渲染各种图表
  • 插件分类:[‘obsidian 插件 ’, ‘readme’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装

概述

使用系统原生包来渲染各种图表

原文出处

下面自述文件的来源于 Readme


Readme(翻译)

下面是 universal-renderer 插件的自述翻译

通用渲染器

Warning

我为自己制作了这个插件,可能在其他系统上无法正常工作,并且缺乏花哨的 GUI 设置

Obsidian 中渲染各种图表并生成动态的 SVG。 (类似于 Obsidian kroki)

Note

该插件使用系统包进行图表渲染(js 端口较慢,我想要原生的东西)

支持的图表

图表文档代码块标签
graphvizgraphviz.orgdot
latexlatex-project.orglatex
ditaaditaa.sourceforge.netditaa
blockdiagblockdiag.comblockdiag
asciidocasciidoc.orgasciidoc
plantumlplantuml.complantuml
typsttypst.apptypst

特殊图表

| 图表 | 文档 | 代码块标签 |

| - | - | - |

| refgraph | refgraph | refgraph |

| dynamic-svg | dynamic svg | dynamic-svg |

安装

从社区商店

只需在 obsidian 社区插件中搜索“通用渲染器”

  • 从发布部分将 main.jsstyles.cssmanifest.json 复制到您的保险库 <VaultFolder>/.obsidian/plugins/universal-renderer/
  • 克隆这个存储库
  • 运行 npm iyarn 安装依赖
  • 运行 npm run build
  • main.jsstyles.cssmanifest.json 复制到您的保险库 <VaultFolder>/.obsidian/plugins/universal-renderer/ 中。
  • 通过系统包管理器安装 graphviz, latex, asciidoc 和其他软件包(您可以在插件设置中自定义可执行文件位置)
  • 通过 BRAT 插件搜索安装 BRAT 插件
  • 阅读文档
  • 添加https://github.com/dgudim/obsidian-universal-renderer

用法

  • 使用渲染器支持的图表类型作为语言创建一个围栏代码块(查看 支持的图表 列表)
  • 使用 图表参数 来自定义图表的外观
  • 在代码块内指定您的图表代码

自定义图表颜色

  1. 打开 palattegen.ts
  2. 修改 colorsshades 常量以符合您的喜好(默认主题为 gruvbox)
  3. 重新构建插件
  4. 删除 styles.css
  5. 重新启用插件/重启 Obsidian 2

图参数

在图表代码之前可以指定各种参数,类似于 obsidian 的前置信息

可用参数

ParamaterDescription
width渲染图形的宽度,可以是任何 css 大小修饰符(%, px, em 等)
doc-start在渲染之前在图表代码前面添加的字符串(与预设一起使用)
doc-enddoc-start 相同,但是附加而不是前置
ref-name
graph-name
name
设置图表名称,以便稍后通过 ref graph 重用
preset应用于图表的一组参数(参见 presets
invert-shade
invert-color
反转图表的阴影或颜色
<svg tag>-fill/stroke:keep-shade/color/all在特定的 svg 标签(例如圆圈、文本、线条)中冻结颜色阴影在浅色/深色主题中的反转
```
---
invert-shade:1
width:90%
text-fill:keep-shade
---
<diagram code>
```

预设

默认情况下有 2 个明确的预设定义

预设描述
math-graph在具有白色节点的 graphviz 图上看起来很好(将 ellipsetext 填充模式设置为 keep-shade
default-tikz通过 doc-startdoc-end 参数附加一些样板代码(有关预设参数,请参见 processor.ts

还有一些默认应用的预设

预设描述
default-latex应用于所有 latex 图形,添加一些样板起始和结束代码
default-plantuml应用于所有 plantuml 图形,分别在代码的开头和结尾添加 @startuml@enduml

定义预设

  1. 打开 processors.ts
  2. 修改 presets 常量以符合您的喜好,预设可以包含任何 图参数
  3. 重新构建插件
Note

default-<diagram type>开头的预设将默认应用于该图表类型

Refgraph

一种特殊的图表类型,用于减少代码重复,只显示已经渲染的图表

语法如下:

```refgraph
<图表名称>
```

图表名称由 name/ref-name/graph-name 参数设置(参见 图表参数

动态 svg

这甚至不是一个图表,这段代码的目的是使您的 svg 遵循定义的颜色方案(例如,您有一个黑色的 svg,在暗色主题下看起来很糟糕)

语法和示例:

```dynamic-svg
---
invert-shade
width:100%
---
[[文件名]]
```

在这里,我们取一些 svg,使其遵循颜色方案(请参阅 自定义图表颜色)并反转其色调(从黑色到白色等)

Note

这对于非优化的大型 svg 或复杂的 svg 效果不佳



反馈交流

其他渠道

版权声明