Obsidian VSCode Editor 项目教程

31 0 0

Obsidian VSCode Editor 项目教程

obsidian-vscode-editorEdit Code Files like VSCode in Obsidian.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-vscode-editor

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

Obsidian VSCode Editor 项目的目录结构如下：


obsidian-vscode-editor/
├── .github/
│   └── workflows/
├── assets/
│   ├── css/
│   └── js/
├── src/
│   ├── main.ts
│   ├── editor.ts
│   └── settings.ts
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录结构介绍

.github/workflows/: 包含 GitHub Actions 的工作流配置文件。assets/: 包含项目的静态资源，如 CSS 和 JavaScript 文件。src/: 包含项目的源代码文件，主要功能模块都在此目录下。
main.ts: 项目的入口文件。editor.ts: 编辑器功能实现文件。settings.ts: 配置管理文件。 .gitignore: Git 忽略文件配置。LICENSE: 项目许可证文件。README.md: 项目说明文档。package.json: 项目依赖和脚本配置文件。tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。该文件负责初始化插件，加载必要的模块，并启动编辑器功能。

主要功能

初始化 Obsidian 插件环境。加载编辑器配置。启动 Monaco Editor 实例。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。


{
  "name": "obsidian-vscode-editor",
  "version": "1.0.0",
  "description": "Edit Code Files like VSCode in Obsidian",
  "main": "src/main.ts",
  "scripts": {
    "build": "tsc",
    "watch": "tsc -w"
  },
  "dependencies": {
    "obsidian": "^0.12.0"
  },
  "devDependencies": {
    "typescript": "^4.4.3"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了编译选项和文件包含规则。


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

通过以上配置，项目可以顺利编译和运行。

obsidian-vscode-editorEdit Code Files like VSCode in Obsidian.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-vscode-editor

# 随笔