【亲测免费】 Obsidian-Jupyter 插件安装与使用指南

目录结构及介绍

在克隆或下载了https://github.com/tillahoffhoffman/obsidian-jupyter.git仓库之后，你会看到以下主要文件和目录:

主要文件

• README.md: 介绍了插件的功能、兼容性和安装步骤。
• .gitignore: 告诉 Git 忽略哪些文件夹或文件，以防止私人数据被提交到版本库中。

主要目录

• src: 包含插件的主要源代码，包括TypeScript 和 JavaScript 文件。
  • main.ts: 这个 TypeScript 文件是插件的核心入口点，它定义了插件类 ObsidianJupyterPlugin，用于注册事件监听器和初始化UI元素。
  • settings.ts: 定义了插件的设置界面和选项，如Python解释器路径等。
• public: 包含插件运行时所需的静态资源(例如样式表和图像文件)，其中:
  • style.css: 为插件提供自定义视觉样式和布局。
  • 图像和其他媒体文件可能也存储在此目录下，以便在用户界面上显示。

启动文件介绍

插件的主文件是src/main.ts。这个文件包含了创建并激活插件所需的所有逻辑。当Obsidian加载插件时，activate()函数会被调用。

在main.ts中，你可以找到如何设置插件的命令、事件监听器和设置面板的例子。

例如，一个简单的事件监听器可以通过以下方式添加：

this.registerEvent(
	this.app.workspace.on('editorOpen', () => {
		console.log('Editor opened');
	})
);

这将在每次打开编辑器时，在控制台中打印出消息“Editor opened”。

此外，activate()函数还负责设置插件的设置页面：

this.registerSetting(setting => {
	setting.setName('Python Interpreter');
	setting.addText(text => text.setValue(this._config.pythonInterpreter).onChange(value => {
		this._config.pythonInterpreter = value;
		saveData(this._config);
	}));
});

这段代码允许用户在插件的设置页面上指定Python解释器的路径。

配置文件介绍

配置文件对于任何插件都是至关重要的，因为它允许用户调整行为和功能。

在obsidian-jupyter插件中，可以使用YAML前项来指定特定文档中的Python解释器：

---
obsidian-jupyter:
  interpreter: /path/to/your/python/interpreter
---

此配置将应用于所有使用Jupyter语言的代码块。如果没有提供，则使用默认的全局设置。

除此之外，插件的全局配置可以通过其设置面板访问，该面板可以在Obsidian应用程序的设置菜单中找到。这里，用户可以指定Python解释器的全局路径、是否启用自动刷新等功能。

重要的是要注意，为了确保插件正常工作，jupyter, nbconvert, nbformat 等必要的Python包必须通过pip安装且是最新的版本。如果这些依赖关系没有正确安装或更新，插件可能无法执行Python代码块。为此，插件提供了检查和更新Python依赖性的功能。

总之，通过仔细阅读和遵循插件提供的文档以及上述指导，你应该能够有效地安装、配置和利用obsidian-jupyter插件来增强你的Obsidian笔记应用体验。