Skip to content
On this page

入门指南

您准备好开始开发您的第一个 Obsidian 插件了么?本篇文档会为您介绍插件的概念,以及如何去配置您的开发环境。

插件是什么?

插件是一种可以让您按照自己的喜好定制 Obsidian 的第三方应用。通过开发一个插件,您可以:

  • 扩展或者修改用户界面。
  • 编辑您 中的文件以及目录。
  • 改进 编辑器 以获得更好的记笔记的体验。

想看到插件看起来是个什么样子的,可以查看 插入链接 这个示例。

我需要做些什么?

在您可以开发插件之前,您需要先配置您的开发环境。

Git

Git 是一个可以追踪您代码变化的版本控制系统。您需要通过 Git 来下载示例插件以及发布您的插件。

Node.js

Node.js 是一个可以让您在浏览器以外执行 JavaScript 的 JavaScript 运行时环境。

TypeScript

要想开发一个插件,您需要对 TypeScript 有基本的了解。The TypeScript Handbook 对初学者而言是个不错的选择。

代码编辑器

使用 Visual Studio Code 编辑器可以在 Windows,Linux 以及 macOS 平台下编写 TypeScript。

下一步

现在您的开发环境已经准备完毕,是时候去 创建您的第一个插件了