Obsidian Icon Shortcodes 插件使用教程

Obsidian Icon Shortcodes 插件使用教程

obsidian-icon-shortcodesObsidian Plugin: Insert emoji and custom icons with shortcodes项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-icon-shortcodes

1. 项目目录结构及介绍

obsidian-icon-shortcodes/
├── .github/
│   └── workflows/
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── settings.ts
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录结构说明

• .github/workflows/: 存放GitHub Actions的工作流配置文件。
• src/: 存放插件的主要源代码文件。
  • main.ts: 插件的主入口文件。
  • styles.css: 插件的样式文件。
  • settings.ts: 插件的配置文件。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript配置文件。

2. 项目启动文件介绍

main.ts

main.ts 是 Obsidian Icon Shortcodes 插件的主入口文件。它负责初始化插件并注册所有必要的功能。以下是 main.ts 的主要功能：

• 初始化插件: 在 Obsidian 启动时加载插件。
• 注册命令: 注册插件提供的命令，如插入图标、管理自定义图标等。
• 加载配置: 从 settings.ts 中加载插件的配置。

3. 项目配置文件介绍

settings.ts

settings.ts 文件包含了插件的配置选项。用户可以通过 Obsidian 的设置界面来调整这些选项。以下是 settings.ts 的主要配置项：

• 自定义图标: 允许用户添加和管理自定义图标。
• 图标库: 选择和配置图标库，如 Emoji、FontAwesome 等。
• 快捷键: 设置插入图标的快捷键。

package.json

package.json 文件是 Node.js 项目的配置文件，包含了项目的元数据和依赖项。以下是 package.json 的主要内容：

• name: 项目名称。
• version: 项目版本。
• scripts: 定义了项目的构建和运行脚本。
• dependencies: 项目依赖的第三方库。
• devDependencies: 开发环境依赖的第三方库。

tsconfig.json

tsconfig.json 是 TypeScript 项目的配置文件，定义了 TypeScript 编译器的选项。以下是 tsconfig.json 的主要配置项：

• compilerOptions: 编译器选项，如目标版本、模块系统等。
• include: 指定需要编译的文件或目录。
• exclude: 指定不需要编译的文件或目录。

---

以上是 Obsidian Icon Shortcodes 插件的目录结构、启动文件和配置文件的详细介绍。通过这些信息，您可以更好地理解和使用该插件。

obsidian-icon-shortcodesObsidian Plugin: Insert emoji and custom icons with shortcodes项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-icon-shortcodes