Tldraw 在 Obsidian 中的集成教程

Tldraw 在 Obsidian 中的集成教程

tldraw-in-obsidianA plugin to integrate Tldraw into Obsidian.项目地址:https://gitcode.com/gh_mirrors/tl/tldraw-in-obsidian

1. 项目的目录结构及介绍

tldraw-in-obsidian/
├── .github/
│   └── workflows/
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── index.ts
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

• .github/workflows/: 包含GitHub Actions的工作流配置文件。
• src/: 项目的源代码目录。
  • main.ts: 项目的主入口文件。
  • styles.css: 项目的样式文件。
  • index.ts: 项目的入口文件。
• .gitignore: 指定Git忽略的文件和目录。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript的配置文件。

2. 项目的启动文件介绍

main.ts

main.ts 是项目的启动文件，负责初始化插件并加载必要的资源。以下是文件的主要内容：

import { Plugin } from 'obsidian';
import { TldrawPlugin } from './index';

export default class TldrawPlugin extends Plugin {
  async onload() {
    console.log('Tldraw 插件已加载');
    // 初始化插件逻辑
  }

  onunload() {
    console.log('Tldraw 插件已卸载');
  }
}

index.ts

index.ts 是项目的入口文件，负责导出插件类并处理插件的生命周期。以下是文件的主要内容：

import { TldrawPlugin } from './main';

export default TldrawPlugin;

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是文件的主要内容：

{
  "name": "tldraw-in-obsidian",
  "version": "1.0.0",
  "description": "A plugin to integrate Tldraw into Obsidian",
  "main": "src/main.ts",
  "scripts": {
    "build": "tsc -p ./",
    "dev": "tsc -p ./ --watch"
  },
  "keywords": [
    "obsidian",
    "tldraw",
    "plugin"
  ],
  "author": "holxsam",
  "license": "MIT",
  "devDependencies": {
    "typescript": "^4.5.5"
  },
  "dependencies": {
    "obsidian": "^0.13.19"
  }
}

tsconfig.json

tsconfig.json 文件是TypeScript的配置文件，定义了编译选项和文件包含规则。以下是文件的主要内容：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": [
    "src/**/*"
  ]
}

通过以上内容，您可以了解 tldraw-in-obsidian 项目的目录结构、启动文件和配置文件的基本信息。希望这份教程对您有所帮助！

tldraw-in-obsidianA plugin to integrate Tldraw into Obsidian.项目地址:https://gitcode.com/gh_mirrors/tl/tldraw-in-obsidian