Obsidian Admonition 插件使用教程

Obsidian Admonition 插件使用教程

admonitions 项目地址: https://gitcode.com/gh_mirrors/adm/admonitions

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

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

.admonitions/
.git/
.github/
icons/
src/
.gitattributes
.gitignore
.release-please-manifest.json
CHANGELOG.md
LICENSE
README.md
esbuild.config.mjs
esbuild.publish.mjs
manifest.json
package-lock.json
package.json
release-please-config.json
svelte.config.js
tsconfig.json
versions.json

• .admonitions/：存放自定义的警告样式文件。
• .git/：Git 版本控制系统的工作目录。
• .github/：包含 GitHub Actions 工作流文件。
• icons/：存放插件的图标文件。
• src/：源代码目录，包含插件的主要逻辑。
• .gitattributes：定义 Git 仓库中文件的编码和二进制属性。
• .gitignore：指定 Git 忽略的文件和目录。
• release-please-manifest.json：发布请求数据文件。
• CHANGELOG.md：记录插件的更新历史和变更。
• LICENSE：插件的许可证信息，本项目采用 MIT 许可证。
• README.md：项目说明文件，包含插件的介绍和用法。
• esbuild.config.mjs：esbuild 配置文件。
• esbuild.publish.mjs：esbuild 发布配置文件。
• manifest.json：插件的配置文件，定义插件的基本信息和功能。
• package-lock.json：npm 包锁定文件，保证项目依赖的一致性。
• package.json：npm 包的配置文件，包含项目依赖和脚本。
• release-please-config.json：发布请求数据配置文件。
• svelte.config.js：Svelte 配置文件。
• tsconfig.json：TypeScript 配置文件。
• versions.json：版本信息文件。

2. 项目的启动文件介绍

Obsidian Admonition 插件作为 Obsidian 的插件，并不存在传统的启动文件。插件通过在 Obsidian 的插件市场中安装后，由 Obsidian 本身负责加载和管理。

在 manifest.json 文件中定义了插件的基本信息和入口点，例如：

{
  "id": "obsidian-admonition",
  "name": "Admonition",
  "namespace": "obsidian",
  "version": "10.3.2",
  "description": "Adds admonition block-styled content to Obsidian.md",
  "author": "javalent",
  "author_url": "https://github.com/valentine195",
  "license": "MIT",
  "min_app_version": "0.12.0",
  "main": "main.js"
}

其中 "main": "main.js" 指定了插件的入口文件，该文件通常位于 src/ 目录下。

3. 项目的配置文件介绍

插件的配置主要通过 manifest.json 文件进行，以下是该文件的一些关键配置项：

• id：插件的唯一标识符。
• name：插件名称。
• namespace：插件命名空间，通常是 obsidian。
• version：插件的版本号。
• description：插件的简短描述。
• author：插件作者的名称。
• author_url：插件作者的 GitHub 链接。
• license：插件所使用的许可证类型。
• min_app_version：插件所需的最小 Obsidian 应用版本。
• main：插件的入口文件路径。

在插件加载时，Obsidian 会读取 manifest.json 文件，并根据这些配置项加载和初始化插件。插件的具体行为和功能实现在 main.js 以及其他源代码文件中定义。

admonitions 项目地址: https://gitcode.com/gh_mirrors/adm/admonitions