请读我.md

功能

将包括 typora-plugin 所有功能在内的 Typora 的一切能力通过 json-rpc 的形式暴露出去，以供 外部操纵 Typora。

如何使用

1. 启动 json_rpc 插件。如此一来，当运行 Typora 后，内部就会自动运行一个 json-rpc-server。
2. 使用你喜欢的语言写一个 json-rpc-client，与 Typora 交互。

以下为 node 和 python 的 example。

node

// 文件位于./plugin/json_rpc/node-json-rpc.js，需要改为你的路径
const rpc = require("D:/software/Typora/resources/app/plugin/json_rpc/node-json-rpc.js")

const options = {
    port: 5080,
    host: '127.0.0.1',
    path: '/',
    strict: false
};

const client = new rpc.Client(options);

const handle = (err, res) => {
    if (err) { console.log(err); }
    else { console.log(res); }
}

client.call({ method: "ping", params: [] }, handle);
client.call({ method: "callPluginFunction", params: ["search_multi", "call"] }, handle);
client.call({ method: "eval", params: ["console.log(this, File)"] }, handle);

python

import requests

url = "http://localhost:5080"


def _call(method, *params):
    return requests.post(url, json={"method": method, "params": params, "jsonrpc": "2.0"}).json().get("result")


def test():
    assert _call("ping") == "pong from typora-plugin"


def call_plugin_function(fixed_name, *args):
    _call("callPluginFunction", fixed_name, *args)


def eval_typora(eval_str):
    _call("eval", eval_str)


if __name__ == "__main__":
    # 测试
    test()
    # 切换只读模式
    call_plugin_function("read_only", "call")
    # 切换到第一个标签页
    call_plugin_function("window_tab", "switchTab", 0)
    # 执行alert
    eval_typora("alert('this is test')")

API

目前暴露三个接口：

ping

• 功能：验证功能是否打通，成功时返回 pong from typora-plugin
• 参数：无

callPluginFunction

• 功能：调用 typora-plugin 能力
• 参数：(fixedName，functionName，…args)
  • fixedName：插件的名称
  • functionName：源码中插件的方法
  • args：插件方法参数

eval

• 功能：执行 eval()
• 参数：evalString。
  • 需要执行的字符串