AI导哈

Vue3插件开发模板

一个基于Vite和Vue3的思源笔记插件开发模板，提供自动化构建和发布功能。

  • by max-miksher
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 max-miksher/siyuan-mcp-server

使用说明

思源插件模板-Vite&Vue3

简体中文

与...一致 思源/插件示例.

  1. 使用Vite进行包装
  2. 使用Vue3进行开发
  3. 提供一个github操作模板，用于自动生成package.zip并上传到新版本
  4. 提供自动创建标记和发布的脚本。 链接

[！注意]

开始之前，您需要安装 NodeJS 的 和 pnpm 第一。

开始

  1. 使用 Use the template 按钮，将此仓库复制为模板。

[！警告]

存储库名称应与插件名称匹配，默认分支必须为 main.

  1. 使用 git clone 将复制的仓库克隆到您的计算机。

  2. 使用 pnpm i 安装依赖项。

  3. 复制 .env.example 文件为 .env，设置 VITE_SIYUAN_WORKSPACE_PATH 前往您的思源工作区。

[！提示]

如果你不喜欢将项目构建到你的工作空间中，你可以使用 Symbolic Link 链接文件夹。

集 VITE_DEV_DIST_DIR 到任何文件夹，并使用 Symbolic Link 连接 siyuan_workspace/data/plugins/your_plugin_name 向 VITE_DEV_DIST_DIR.

  1. 使用 pnpm dev 运行该项目。 如果成功，您将在中找到该插件 Siyuan - Settings - Marketplace，命名为 plugin-sample-vite-vue.

  2. 启用插件，并检查 App.vue 文件开始开发。

    此文件包含一些示例代码。

[！提示]

更多插件代码示例，请查看 思源/插件示例/src/index.ts

市场上的列表

使用Github操作

  1. 您可以创建一个新标签，使用您的新版本号作为 Tag version 在你当地。
  2. 然后将标签推送到Github。Github Action将为您创建一个新的版本。

[！提示]

This template provided a script to auto create tag and release. You can use `pnpm release` to create a patch version.

您可以添加 --mode=manual|patch|minor|major arg设置释放模式，或像arg一样运行 pnpm release:manual.

请查看所有脚本 package.json 文件。

github操作包含在此示例中，您可以使用它自动将新realse发布到市场：

  1. 在您的仓库设置页面中 https://github.com/OWNER/REPO/settings/actions，下到“工作流权限”并打开配置，如下所示：
  1. 按格式推送标签 v* github将自动使用new bulit package.zip创建一个新版本
  2. 默认情况下，它只会发布预发布版本，如果您认为没有必要，请更改release.yml中的设置
- name: Release
    uses: ncipollo/release-action@v1
    with.
        allowUpdates: true
        artifactErrorsFailBuild: true
        artifacts: 'package.zip'
        token: ${{ secrets.GITHUB_TOKEN }}
        prerelease: true # change this to false

手册

  1. 使用 pnpm build 生成 package.zip
  2. 使用您的新版本号作为“标记版本”创建新的Github版本。请参阅此处查看示例：https://github.com/siyuan-note/plugin-sample/releases
  3. 将文件package.zip作为二进制附件上传
  4. 发布发布

[！注意] 如果这是第一个版本，请向 社区集市 repository并修改其中的plugins.json文件。此文件是所有社区插件repository的索引，格式为：

{
  "repos": [
    "username/reponame"
  ]
}

更多其他插件信息，请查看 思源/插件示例.

相关 MCP