Obsidian 执行代码插件技术文档

Obsidian 执行代码插件技术文档

obsidian-execute-code Obsidian Plugin to execute code in a note. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-execute-code

此文档旨在提供全面指导，帮助用户了解并高效使用 Obsidian 执行代码插件。该插件使您能在笔记中的代码块执行代码片段，并展示运行结果。以下内容包含安装指南、使用说明、API概述及详细安装步骤。

安装指南

直接在 Obsidian 内安装

1. 在您的 Obsidian 应用程序内，导航到“设置” > “社区插件”。
2. 在搜索框中输入“Obsidian Execute Code”，找到由 twibiral 开发的插件。
3. 点击“安装”按钮进行安装。

通过 GitHub 下载手动安装

1. 访问插件的 GitHub 仓库。
2. 下载最新版本的插件文件（通常位于 Releases 页面）。
3. 将下载的 .zip 文件解压，并按照 Obsidian 的插件管理指示将插件目录放置于正确的插件路径下。

项目的使用说明

一旦安装完成，重启 Obsidian 后，您可以在支持的语言的代码块上看到一个“运行”按钮。

1. 编写或选择含有支持语言的代码块。
2. 单击代码块旁的“运行”按钮来执行代码。
3. 结果将在下方显示，对于支持嵌入图形的语言（如 Python 和 Rust），图形会直接嵌入笔记中。

支持的编程语言概览

本插件支持包括但不限于 C, Java, Python, JavaScript 在内的多种语言。每种语言的具体要求与配置细节，请参考 README 文件中的详细描述。

项目API使用文档

该插件并未公开传统意义上的 API 接口，它的功能主要是通过 Obsidian UI 进行交互。然而，插件提供了配置选项，允许用户自定义路径和调整环境，这可以视为一种间接的“API”。

• 魔法命令：利用特定注释触发插件功能，例如访问 Obsidian 中的路径或展示图片。
• 全局代码注入：允许预设代码，这些代码会在同一语言的所有代码块执行前后自动运行。

项目安装方式回顾

确保遵循上述的安装指南。无论是通过直接安装还是手动导入 .zip 文件的方式，关键在于正确集成到您的 Obsidian 环境中，并配置好必要的外部依赖（如 Node.js 对于 JavaScript，Python 路径等）。

请注意，根据所使用的编程语言，可能需要额外的系统配置，例如安装特定的 SDK 或工具。每个语言的支持部分在 README 文件中列出了详细的启动条件和配置步骤，请务必参照相关细节进行正确配置。

以上即是 Obsidian 执行代码插件的综合技术文档，希望它能让您的笔记过程更加动态和高效。

obsidian-execute-code Obsidian Plugin to execute code in a note. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-execute-code