Obsidian Weread Plugin 使用教程
项目的目录结构及介绍
Obsidian Weread Plugin 的目录结构如下:
obsidian-weread-plugin/
├── .github/
│ └── workflows/
│ └── main.yml
├── .obsidian/
│ └── plugins/
│ └── weread-plugin/
│ ├── main.js
│ ├── manifest.json
│ └── styles.css
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── src/
├── main.ts
├── weread.ts
└── utils.ts
目录结构介绍
.github/workflows/main.yml
: GitHub Actions 的工作流配置文件,用于自动化构建和部署。.obsidian/plugins/weread-plugin/
: Obsidian 插件的存放目录,包含插件的主要文件。main.js
: 插件的主入口文件。manifest.json
: 插件的元数据文件,包含插件的名称、版本等信息。styles.css
: 插件的样式文件。
.gitignore
: Git 忽略文件列表。LICENSE
: 项目的开源许可证。README.md
: 项目的说明文档。package.json
: 项目的依赖管理文件。src/
: 插件的源代码目录。main.ts
: 插件的主入口 TypeScript 文件。weread.ts
: 与微信读书相关的功能实现。utils.ts
: 工具函数。
项目的启动文件介绍
项目的启动文件是 src/main.ts
。这个文件是插件的入口点,负责初始化插件并注册必要的 Obsidian 事件监听器。
src/main.ts
主要内容
import { Plugin } from 'obsidian';
import WereadPlugin from './weread';
export default class MainPlugin extends Plugin {
async onload() {
console.log('加载微信读书插件');
this.addCommand({
id: 'open-weread',
name: '打开微信读书',
callback: () => {
new WereadPlugin(this.app).open();
}
});
}
onunload() {
console.log('卸载微信读书插件');
}
}
启动文件功能介绍
onload()
: 插件加载时调用的方法,注册命令和初始化插件。onunload()
: 插件卸载时调用的方法,清理资源。
项目的配置文件介绍
项目的配置文件主要是 manifest.json
和 package.json
。
manifest.json
manifest.json
文件位于 .obsidian/plugins/weread-plugin/
目录下,包含插件的基本信息和版本号。
{
"id": "weread-plugin",
"name": "微信读书",
"version": "1.0.0",
"minAppVersion": "0.12.0",
"description": "在 Obsidian 中集成微信读书",
"author": "zhaohongxuan",
"authorUrl": "https://github.com/zhaohongxuan",
"isDesktopOnly": false
}
package.json
package.json
文件位于项目根目录下,包含项目的依赖和脚本信息。
{
"name": "obsidian-weread-plugin",
"version": "1.0.0",
"description": "在 Obsidian 中集成微信读书",
"main": "src/main.ts",
"scripts": {
"dev": "rollup --config rollup.config.js -w",
"build": "rollup --config rollup.config.js"
},
"author": "zhaohongxuan",
"license": "MIT",
"devDependencies": {
"@rollup/plugin-commonjs": "^15.1.0",
"@rollup/plugin-node-resolve": "^9.0.0",
"@rollup/plugin-typescript": "^6.0.0",