Obsidian Copy Block Link 项目使用教程

Obsidian Copy Block Link 项目使用教程

obsidian-copy-block-link Get links to blocks and headings from Obsidian's right click menu. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-copy-block-link

1. 项目目录结构及介绍

• /.github: 存放 GitHub Actions 工作流文件。
• /demo.gif: 项目功能演示的 GIF 图片。
• /block-id-tests.md: 用于测试块 ID 的 Markdown 文件。
• /main.ts: 项目的主要 TypeScript 文件。
• /manifest.json: 插件配置文件。
• /package.json: 项目依赖和脚本配置文件。
• /rollup.config.js: Rollup 打包配置文件。
• /tsconfig.json: TypeScript 配置文件。
• /versions.json: 存储版本信息的 JSON 文件。
• /yarn.lock: 依赖锁定文件。

2. 项目的启动文件介绍

main.ts 是项目的主文件，它包含了插件的主要逻辑。这个文件负责监听 Obsidian 的右键菜单事件，并在用户选择相应的菜单项时，生成块或标题的链接。

3. 项目的配置文件介绍

manifest.json 是插件的配置文件，它定义了插件的元数据，如名称、描述、版本等，以及插件需要注册的菜单项和命令。这个文件是插件与 Obsidian 编辑器通信的桥梁，它告诉编辑器如何集成和展示插件的功能。

以下是一个简化的 manifest.json 文件示例：

{
  "name": "Obsidian Copy Block Link",
  "description": "Get links to blocks and headings from Obsidian's right-click menu.",
  "version": "1.0.4",
  "author": "mgmeyers",
  "main": "main.ts",
  "menu": {
    "explorer Context": [
      {
        "id": "copy-block-link",
        "name": "Copy Block Link",
        "action": "command:copy-block-link"
      }
    ]
  }
}

在这个配置文件中，name 定义了插件的名称，description 提供了插件的描述，version 定义了插件的版本。menu 部分定义了右键菜单上下文中的菜单项，以及当用户点击该菜单项时要执行的命令。

obsidian-copy-block-link Get links to blocks and headings from Obsidian's right click menu. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-copy-block-link