Obsidian Auto Timelines 插件使用教程

52 0 0

Obsidian Auto Timelines 插件使用教程

obsidian-auto-timelinesSimple timeline generator plugin for story tellers using obsidian项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-auto-timelines

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

Obsidian Auto Timelines 插件的目录结构如下：


obsidian-auto-timelines/
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── ...
├── test/
│   └── ...
├── .editorconfig
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .npmrc
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── esbuild.config.mjs
├── manifest.json
├── package-lock.json
├── package.json
├── prepare-vitest.mjs
├── shim.d.ts
├── tsconfig.json
├── version-bump.mjs
├── versions.json
└── vitest.config.ts

目录结构介绍

src/: 包含插件的主要源代码文件。
main.ts: 插件的入口文件。styles.css: 插件的样式文件。 test/: 包含插件的测试文件。.editorconfig, .eslintignore, .eslintrc, .gitignore, .npmrc: 配置文件，用于代码格式化和版本控制。CODE_OF_CONDUCT.md: 行为准则文件。LICENSE: 许可证文件。README.md: 项目说明文件。esbuild.config.mjs: esbuild 配置文件。manifest.json: Obsidian 插件的清单文件。package-lock.json, package.json: npm 包管理文件。prepare-vitest.mjs: Vitest 测试准备文件。shim.d.ts: TypeScript 类型声明文件。tsconfig.json: TypeScript 配置文件。version-bump.mjs: 版本更新脚本文件。versions.json: 版本记录文件。vitest.config.ts: Vitest 测试配置文件。

2. 项目的启动文件介绍

插件的启动文件是 src/main.ts。这个文件是插件的入口点，负责初始化插件并加载必要的资源。


// src/main.ts
import { Plugin } from 'obsidian';
import { AutoTimelinesPlugin } from './plugin';
 
export default class AutoTimelines extends Plugin {
  async onload() {
    this.addRibbonIcon('calendar-days', 'Auto Timelines', () => {
      new AutoTimelinesPlugin(this.app).activate();
    });
  }
}

3. 项目的配置文件介绍

`manifest.json`

manifest.json 是 Obsidian 插件的清单文件，包含插件的基本信息和版本信息。


{
  "id": "obsidian-auto-timelines",
  "name": "Auto Timelines",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "Simple timeline generator plugin for story tellers using Obsidian",
  "author": "April Gras",
  "authorUrl": "https://github.com/April-Gras",
  "isDesktopOnly": false
}

`package.json`

package.json 是 npm 包管理文件，包含项目的依赖和脚本命令。


{
  "name": "obsidian-auto-timelines",
  "version": "1.0.0",
  "description": "Simple timeline generator plugin for story tellers using Obsidian",
  "main": "src/main.ts",
  "scripts": {
    "build": "esbuild src/main.ts --bundle --outfile=main.js",
    "test": "vitest"
  },
  "dependencies": {
    "obsidian": "^0.12.0"
  },
  "devDependencies": {
    "typescript": "^4.5.2",
    "vitest": "^0.10.0"
  }
}

`tsconfig.json`

tsconfig.json 是 TypeScript 配置文件，用于配置 TypeScript 编译选项。

obsidian-auto-timelinesSimple timeline generator plugin for story tellers using obsidian项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-auto-timelines

# 随笔