mn-rails

用于快速创建MarginNote4插件打包工程的脚手架。内置AGENTS.md作为AI辅助开发Prompt，建议配合Codex、Trae等开发工具使用。如果你使用AI进行开发，强烈建议先安装MCP。

模板类型

• standard：标准插件模板，纯JavaScriptCore插件结构
• web：Web插件模板，内置React+Vite前端与WebView桥接样板

创建项目

在目标目录运行：

npx mn-rails

创建时可以交互选择模板，也可以直接指定：

npx mn-rails --template standard
npx mn-rails --template web

运行npx mn-rails时，模板、包管理器、是否生成CI会以终端交互菜单展示，可直接用键盘方向键选择并回车确认。

按提示输入addonid/author/title等信息后会生成项目目录。

更新已有项目模板

在已有项目目录运行：

npx mn-rails update
# 或全局安装后
mn-rails update

update会读取当前项目package.json中的mnRails.template来选择模板。若没有该字段，默认按standard处理。

会同步以下内容到当前项目：

• 覆盖更新AGENTS.md
• 覆盖更新模板scripts目录下的脚本文件
• 覆盖更新package.json中由模板管理的scripts键

保留策略：

• 保留用户自定义的package.json scripts键
• 保留scripts目录下不在模板中的用户自定义文件

下一步

进入项目目录：

cd <your-project>
pnpm i
pnpm dev
# or
npm i
npm run dev

更多用法与打包流程见生成项目内的README.md。

注意事项

• 目标目录必须为空目录，否则会中止生成
• 若检测到git可用，会自动git init并创建一次初始commit；否则跳过