cMenu-Plugin 使用教程

cMenu-Plugin 使用教程

cMenu-PluginAn Obsidian.md plugin that adds a minimal text editor modal for a smoother writing/editing experience ✍🏽.项目地址:https://gitcode.com/gh_mirrors/cm/cMenu-Plugin

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

cMenu-Plugin 的目录结构如下：

cMenu-Plugin/
├── .github/
│   └── workflows/
├── assets/
│   └── icons/
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── settings.ts
├── .gitignore
├── .obsidian/
│   └── plugins/
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• assets/icons/: 存放插件使用的图标文件。
• src/: 包含插件的主要源代码文件。
  • main.ts: 插件的主入口文件。
  • styles.css: 插件的样式文件。
  • settings.ts: 插件的设置相关代码。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .obsidian/plugins/: Obsidian 插件的配置目录。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 编译配置文件。

2. 项目的启动文件介绍

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

启动文件主要功能

• 初始化插件实例。
• 注册插件的命令和事件监听器。
• 加载插件的样式文件。

3. 项目的配置文件介绍

cMenu-Plugin 的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了插件的元数据和依赖信息，以及一些脚本命令。

{
  "name": "cmenu-plugin",
  "version": "1.0.0",
  "description": "A minimal and user friendly text editor modal for Obsidian.md",
  "main": "src/main.ts",
  "scripts": {
    "build": "tsc -p ./",
    "dev": "tsc -p ./ --watch"
  },
  "author": "Chetachi E. Uzoukwu",
  "license": "MIT",
  "dependencies": {
    "obsidian": "^0.12.0"
  },
  "devDependencies": {
    "typescript": "^4.4.3"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的编译配置文件，定义了 TypeScript 编译器的行为。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

以上是 cMenu-Plugin 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 cMenu-Plugin。

cMenu-PluginAn Obsidian.md plugin that adds a minimal text editor modal for a smoother writing/editing experience ✍🏽.项目地址:https://gitcode.com/gh_mirrors/cm/cMenu-Plugin