Obsidian Marp 插件使用与配置指南

1. 项目目录结构及介绍

Obsidian Marp 插件的目录结构如下：

obsidian-marp-plugin/
├── src/                      # 源代码目录
│   ├── editorconfig           # 编辑器配置文件
│   ├── eslintignore          # ESLint 忽略文件
│   ├── eslintrc              # ESLint 配置文件
│   ├── gitignore             # Git 忽略文件
│   ├── npmrc                 # npm 配置文件
│   ├── prettierrc            # Prettier 配置文件
│   ├── tsconfig.json         # TypeScript 配置文件
│   └── version-bump.js        # 版本更新脚本
├── manifest.json             # 插件元数据文件
├── package.json              # 项目包配置文件
├── package-lock.json         # 项目包锁定文件
├── README.md                 # 项目说明文件
└── versions.json             # 版本信息文件

• src/: 存放插件的源代码。
• editorconfig: 配置编辑器的代码风格，确保不同开发者之间的编码风格统一。
• eslintignore: 指定 ESLint 忽略的文件和目录。
• eslintrc: ESLint 的配置文件，用于统一代码质量和风格。
• gitignore: 指定 Git 忽略的文件和目录，避免将不必要的文件提交到版本控制。
• npmrc: npm 的配置文件，可以设置项目的特定配置。
• prettierrc: Prettier 的配置文件，用于格式化代码。
• tsconfig.json: TypeScript 的配置文件，指定 TypeScript 编译器的选项。
• version-bump.js: 用于自动更新项目版本的脚本。
• manifest.json: 插件的元数据文件，定义插件的基本信息和权限。
• package.json: 项目包配置文件，定义项目的依赖和脚本。
• package-lock.json: 包锁定文件，确保每次安装依赖时都获得相同的依赖版本。
• README.md: 项目说明文件，描述项目的功能和使用方法。
• versions.json: 版本信息文件，记录插件的版本历史。

2. 项目的启动文件介绍

在 Obsidian Marp 插件中，没有特定的启动文件。插件作为 Obsidian 的一个扩展，通过在 Obsidian 的插件市场中安装并启用后即可使用。

3. 项目的配置文件介绍

插件的配置主要通过 manifest.json 文件进行，以下是该文件的部分内容：

{
  "name": "Obsidian Marp Plugin",
  "id": "obsidian-marp-plugin",
  "version": "1.0.0",
  "description": "Plugin to use Marp with Obsidian",
  "author": "JichouP",
  "namespace": "obsidian-marp-plugin",
  "publisher": "JichouP",
  "icons": {
    "16": "icons/icon16.png",
    "48": "icons/icon48.png",
    "128": "icons/icon128.png"
  },
  "config": {
    "type": "object",
    "properties": {
      "EnableAutoReload": {
        "type": "boolean",
        "default": true
      },
      "EnableOpenPreviewInSplitTab": {
        "type": "boolean",
        "default": true
      },
      "ThemeFolderLocation": {
        "type": "string",
        "default": "MarpTheme"
      }
    }
  },
  // ... 其他配置项
}

在 config 部分，定义了插件的配置项：

• EnableAutoReload: 是否自动刷新预览，默认为 true。
• EnableOpenPreviewInSplitTab: 是否在分割标签中打开预览，默认为 true。
• ThemeFolderLocation: 自定义主题的文件夹路径，默认为 MarpTheme。

用户可以在 Obsidian 的插件设置中修改这些配置，以适应自己的需求。