Obsidian 插件:【Readme】JS Engine

Obsidian 插件:【Readme】JS Engine

插件名片

  • 插件名称:JS Engine
  • 插件作者:Moritz Jung
  • 插件说明:从您的笔记中运行 JavaScript。
  • 插件分类:[‘obsidian 插件 ’, ‘readme’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装

概述

从您的笔记中运行 JavaScript。

原文出处

下面自述文件的来源于 Readme


Readme(翻译)

下面是 js-engine 插件的自述翻译

Obsidian JS 引擎插件

这个 Obsidian 插件允许你使用特殊的代码块在你的笔记中运行 JavaScript。

使用方法

首先使用 js-engine 插件创建一个代码块。在代码块内部,您可以编写任何 JavaScript 代码,并在最后返回一个值。

插件将渲染返回的值,而不是代码块本身。当您不返回任何值时,插件将不会渲染任何内容,代码块将不可见。

API 文档

以下变量在代码块中可用。

名称类型
appApp (Obsidian)
engineAPI (此插件)
contextExecutionContext (此插件) 或 undefined
componentComponent (Obsidian)
containerHTMLElement

可以在 这里 找到 API 和代码块内可用的类型的文档。

例子

Markdown 构建器

let markdownBuilder = engine.markdown.createBuilder();

markdownBuilder.createHeading(2, '测试标题');
markdownBuilder.createParagraph('这是一个测试段落。');

markdownBuilder.createHeading(3, '这是一个子标题');
markdownBuilder.createHeading(4, '这是一个子子标题');
markdownBuilder.createParagraph('这是另一个测试段落。');

输出

测试标题

这是一个测试段落。

这是一个子标题

这是一个子子标题

这是另一个测试段落。

将字符串渲染为 Markdown

let str = '*test*';
return str;
let str = '*test*';
return engine.markdown.create(str);

顶部的示例将字符串渲染为纯文本,而第二个示例将文本渲染为 Markdown。

* 测试*

测试

导入 JS

let lib = await engine.importJs('lib.js');
return lib.getGreeting();

在存储库的根目录下有一个名为 lib.js 的文件。

export function getGreeting() {
	return 'Hello!';
}

你好!



反馈交流

其他渠道

版权声明