Zotero Better Notes 项目教程

项目的目录结构及介绍

Zotero Better Notes 项目的目录结构如下：

zotero-better-notes/
├── docs/
├── scripts/
│   └── docx/
├── src/
├── typings/
├── env-example/
├── .gitattributes
├── .gitignore
├── .prettierignore
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── tsconfig.json
├── update-beta.json
├── update.json
├── update.rdf
├── zotero-plugin-config.ts

目录介绍

• docs/: 包含项目文档文件。
• scripts/docx/: 包含与 docx 相关的脚本文件。
• src/: 包含项目的源代码文件。
• typings/: 包含 TypeScript 类型定义文件。
• env-example/: 包含环境配置示例文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略配置文件。
• .prettierignore: Prettier 忽略配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• package-lock.json: npm 依赖锁定文件。
• package.json: npm 项目配置文件。
• tsconfig.json: TypeScript 配置文件。
• update-beta.json: 更新配置文件（测试版）。
• update.json: 更新配置文件。
• update.rdf: 更新配置文件（RDF 格式）。
• zotero-plugin-config.ts: Zotero 插件配置文件。

项目的启动文件介绍

Zotero Better Notes 项目的启动文件主要是 package.json 文件中的 scripts 部分。以下是启动命令的介绍：

{
  "scripts": {
    "build": "npm run clean && npm run compile && npm run package",
    "clean": "rimraf builds && mkdirp builds",
    "compile": "tsc -p .",
    "package": "cd src && zip -r ../builds/zotero-better-notes.xpi *",
    "start": "npm run build"
  }
}

启动命令介绍

• build: 构建项目，包括清理、编译和打包。
• clean: 清理构建目录。
• compile: 编译 TypeScript 代码。
• package: 打包项目文件。
• start: 启动项目构建过程。

项目的配置文件介绍

Zotero Better Notes 项目的主要配置文件包括：

• package.json: 包含项目的依赖、脚本和其他配置信息。
• tsconfig.json: TypeScript 编译配置文件。
• zotero-plugin-config.ts: Zotero 插件配置文件。

package.json

{
  "name": "zotero-better-notes",
  "version": "1.0.0",
  "description": "Everything about note management All in Zotero",
  "main": "src/index.ts",
  "scripts": {
    "build": "npm run clean && npm run compile && npm run package",
    "clean": "rimraf builds && mkdirp builds",
    "compile": "tsc -p .",
    "package": "cd src && zip -r ../builds/zotero-better-notes.xpi *",
    "start": "npm run build"
  },
  "dependencies": {
    // 依赖包列表
  },
  "devDependencies": {
    // 开发依赖包列表
  }
}

tsconfig.json

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

zotero-plugin-config.ts

// Zotero 插件配置示例
export const config = {
  // 配置项
};

以上是 Zotero Better Notes