Obsidian 插件:Code Preview

Obsidian 插件:Code Preview

插件名片

  • 插件名称:Code Preview
  • 插件作者:Hank
  • 插件说明:文件路径预览代码块
  • 插件分类:[‘obsidian 插件 ’, ‘readme’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装

概述

文件路径预览代码块

原文出处

下面自述文件的来源于 Readme


Readme(翻译)

下面是 obsidian-code-preview 插件的自述翻译

Obsidian 代码预览插件

Chinese

具体的例子可以使用 Open folder as vault 打开 example.zip

路径

基本

代码语言由路径的扩展名确定

```preview
路径:hello.js
```
相对路径
```preview
路径:./hello.js
```
绝对路径

根路径是 Vault 文件夹

```preview
路径:/sub/color.css
```
```preview
路径:/hello.js
```

CodeBlock 语言

代码语言通过路径的扩展名确定

语言键:languagelang

language、lang
```preview
path: ./hello.js
lang: ts
```
```preview
path: ./hello.js
language: ts
```

选择显示行范围

自定义起始或结束

文件的第三行结束
```preview
路径:/sub/color.css
起始:3
```
第一行到第三行
```preview
路径:/sub/color.css
结束:3
```
仅预览第三行
```preview
路径:/sub/color.css
起始:3
结束:3
```
行范围
```preview
路径:/sub/color.css
起始:2
结束:3
```
结束增加起始

结束:"+1",配置中需要使用 "

```preview
路径:/sub/color.css
起始:2
结束:"+1"
```
使用正则表达式或搜索文本

/dd\d{2}/

```preview
路径:/sub/color.css
起始:body
结束:/dd\d{2}/
```

如果您不了解正则表达式,可以直接使用文本。例如:

起始:body:匹配行内的 body

结束:dd00dd:匹配行内的 dd00dd

```preview
路径:/sub/color.css
起始:body
结束:dd00dd
```

高亮

按行
```preview
path: /sub/color.css
highlight: 1
```
范围
```preview
path: /sub/color.css
highlight: 1-3
```
搜索文本
```preview
path: /sub/color.css
highlight: dd00dd
```
正则表达式
```preview
path: /sub/color.css
highlight: /dd\d{2}/
```
多个规则

分隔符 ,

```preview
path: /sub/color.css
highlight: /dd\d{2}/, 1, body
```

YAML 列表

```preview
path: /sub/color.css
highlight:
  - /dd\d{2}/
  - 1
  - body
```

CodeBlock YAML 配置

配置项描述类型默认值
path文件路径字符串必填
start预览起始行。从 1 开始计数数字或字符串或正则表达式-
end预览结束行数字或字符串或正则表达式-
highlight高亮显示的行数字或字符串或正则表达式-
linenumber显示行号,优先级高于插件配置true 或 false插件配置

插件配置

配置项描述类型默认值
watchAlias监听别名文件夹的变化,更新输入建议。可能会影响性能布尔值false
watchCode监听预览的代码文件的变化,当文件发生变化时更新渲染。可能会影响性能布尔值false
highLightColor高亮背景颜色CSS 颜色#2d82cc20
include包含的路径,留空表示全部Array<string or RegExp>[]
exclude排除的路径Array<string or RegExp>[“node_modules”, “.obsidian”]
includeFile包含的文件,必填Array<string or RegExp>[”/\.js/“]
excludeFile排除的文件Array<string or RegExp>[]
alias别名路径字符串或别名code
linenumber显示行号true 或 falsetrue

linenumber, highlight 基于 obsidian-better-codeblock 的实现



反馈交流

其他渠道

版权声明