Obsidian-AVA 开源项目教程
1. 项目的目录结构及介绍
Obsidian-AVA 项目的目录结构如下:
obsidian-ava/
├── .github/
│ └── workflows/
├── assets/
│ ├── icon.png
│ └── styles.css
├── src/
│ ├── main.ts
│ ├── preview.ts
│ └── settings.ts
├── .gitignore
├── .npmrc
├── README.md
├── package.json
├── tsconfig.json
└── webpack.config.js
目录结构介绍
- .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
- assets/: 包含项目的静态资源,如图标和样式文件。
- src/: 包含项目的主要源代码文件。
- main.ts: 主入口文件。
- preview.ts: 预览功能的相关代码。
- settings.ts: 设置页面的相关代码。
- .gitignore: 指定 Git 忽略的文件和目录。
- .npmrc: npm 配置文件。
- README.md: 项目说明文档。
- package.json: 项目依赖和脚本配置。
- tsconfig.json: TypeScript 编译配置。
- webpack.config.js: Webpack 打包配置。
2. 项目的启动文件介绍
项目的启动文件是 src/main.ts
。这个文件是 Obsidian-AVA 插件的入口点,负责初始化插件并加载其他模块。
主要功能
- 初始化插件实例。
- 注册命令和事件监听器。
- 加载预览和设置模块。
3. 项目的配置文件介绍
package.json
package.json
文件包含了项目的元数据和依赖信息。以下是一些关键字段:
- name: 项目名称。
- version: 项目版本。
- description: 项目描述。
- main: 主入口文件路径。
- scripts: 可执行的脚本命令。
- dependencies: 生产环境依赖。
- devDependencies: 开发环境依赖。
tsconfig.json
tsconfig.json
文件用于配置 TypeScript 编译选项。以下是一些关键字段:
- compilerOptions: 编译器选项,如目标版本、模块系统等。
- include: 包含的文件和目录。
- exclude: 排除的文件和目录。
webpack.config.js
webpack.config.js
文件用于配置 Webpack 打包选项。以下是一些关键字段:
- entry: 入口文件路径。
- output: 输出文件路径和名称。
- module: 模块加载器配置。
- plugins: 使用的插件列表。
通过以上配置文件,可以确保项目在开发和构建过程中的一致性和高效性。