Obsidian 笔记模板插件使用教程
obsidian-note-from-templateSimple plugin to create Notes from a template, and fill in fields defined there项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-note-from-template
1. 项目的目录结构及介绍
obsidian-note-from-template/
├── .github/
│ └── workflows/
│ └── main.yml
├── .obsidian/
│ └── templates/
│ └── example-template.md
├── src/
│ ├── main.ts
│ └── utils.ts
├── .gitignore
├── LICENSE
├── README.md
└── package.json
.github/workflows/: 包含GitHub Actions的工作流配置文件。.obsidian/templates/: 存放Obsidian模板文件的目录。src/: 项目的源代码目录,包含主要的TypeScript文件。.gitignore: 指定Git版本控制系统忽略的文件和目录。LICENSE: 项目的开源许可证文件。README.md: 项目的主要说明文档。package.json: 项目的npm配置文件,包含依赖项和脚本。
2. 项目的启动文件介绍
项目的启动文件位于src/main.ts
,这是插件的主入口点。它负责初始化插件并注册必要的命令和事件监听器。
// src/main.ts
import { Plugin } from 'obsidian';
import { ExampleCommand } from './utils';
export default class ExamplePlugin extends Plugin {
async onload() {
console.log('插件已加载');
this.addCommand(ExampleCommand);
}
onunload() {
console.log('插件已卸载');
}
}
3. 项目的配置文件介绍
项目的配置文件主要是package.json
,它包含了项目的基本信息、依赖项、脚本等。
{
"name": "obsidian-note-from-template",
"version": "1.0.0",
"description": "一个Obsidian插件,用于从模板创建笔记",
"main": "src/main.ts",
"scripts": {
"build": "tsc -p ./",
"dev": "tsc -p ./ --watch"
},
"keywords": [
"obsidian",
"plugin",
"template"
],
"author": "mo-seph",
"license": "MIT",
"devDependencies": {
"typescript": "^4.0.0"
},
"dependencies": {
"obsidian": "^0.12.0"
}
}
name: 项目的名称。version: 项目的版本号。description: 项目的描述。main: 项目的入口文件。scripts: 包含可执行的脚本命令。keywords: 项目的关键词。author: 项目的作者。license: 项目的许可证。devDependencies: 开发依赖项。dependencies: 运行依赖项。
obsidian-note-from-templateSimple plugin to create Notes from a template, and fill in fields defined there项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-note-from-template