From 5d6baa368497f64d325e88718130a1f375b83026 Mon Sep 17 00:00:00 2001 From: dongrentianyu <3465645884@qq.com> Date: Mon, 21 Oct 2024 03:41:10 +0800 Subject: [PATCH] add some docs --- ...ut debugging.tid => 012-about-debugging.tid} | 2 +- .../tutorials/en/013-develop-more-plugins.tid | 17 +++++++++++++++++ src/doc/tutorials/zh/011-about-deployment.tid | 2 +- .../doc/tutorials/zh/012-about-debugging.tid | 2 +- .../tutorials/zh/013-develop-more-plugins.tid | 17 +++++++++++++++++ 5 files changed, 37 insertions(+), 3 deletions(-) rename src/doc/tutorials/en/{012-About debugging.tid => 012-about-debugging.tid} (96%) create mode 100644 src/doc/tutorials/en/013-develop-more-plugins.tid rename "src/doc/tutorials/zh/012-\345\205\263\344\272\216\350\260\203\350\257\225.tid" => src/doc/tutorials/zh/012-about-debugging.tid (96%) create mode 100644 src/doc/tutorials/zh/013-develop-more-plugins.tid diff --git a/src/doc/tutorials/en/012-About debugging.tid b/src/doc/tutorials/en/012-about-debugging.tid similarity index 96% rename from src/doc/tutorials/en/012-About debugging.tid rename to src/doc/tutorials/en/012-about-debugging.tid index 932e93e..6f6f768 100644 --- a/src/doc/tutorials/en/012-About debugging.tid +++ b/src/doc/tutorials/en/012-about-debugging.tid @@ -1,4 +1,4 @@ -title: $:/plugins/Modern.TiddlyDev/doc/tutorials/en/012-关于调试 +title: $:/plugins/Modern.TiddlyDev/doc/tutorials/en/012-about-debugging caption: About debugging authors: whitefall type: text/vnd.tiddlywiki diff --git a/src/doc/tutorials/en/013-develop-more-plugins.tid b/src/doc/tutorials/en/013-develop-more-plugins.tid new file mode 100644 index 0000000..514e029 --- /dev/null +++ b/src/doc/tutorials/en/013-develop-more-plugins.tid @@ -0,0 +1,17 @@ +title: $:/plugins/Modern.TiddlyDev/doc/tutorials/en/develop-more-plugins +caption: Develop More Plugins +authors: mabuqian(马不前) +type: text/vnd.tiddlywiki + + +Multiple plugins can be developed at the same time in the same repository. These plugins can be attributed to sub-plugins or related plugins. This can be avoided to increase the plug-in repository, adding too much later will be more difficult to maintain. + +Developing a new plugin uses the same commands as the original plugin. + +`npm run new` or `pnpm run new`, then just fill in the appropriate plugin information. A new plugin folder will be created in the `src` folder. + +Once the plugin is developed,you can be submitted to the CPL. The submission process is to open [[CPL repository|https://github.com/tiddly-gittly/TiddlyWiki-CPL]] and fork a copy to your own repository. Then download it and open it with [[TidGi|https://github.com/tiddly-gittly/TidGi-Desktop]]. And add a new plugin entry. Be careful to add the address of the repository where the plugin was downloaded in the URL field, usually in the form of `https://github.com/tiddly-gittly/tiddlywiki-plugins/releases/latest/download/$plugin-name$.json`, so that CPL will search for and download the plugin. + +After that, submit the PR to the CPL repository and wait for the administrator to review it. After approval, you can search and download the plugin in your own TiddlyWiki by CPL. + +The plugin repository needs to be released so that CPL can search for the latest version, and it needs to be named in `v.x.x.x` format. It is possible to use a version number like `v2024.3.23-1` as in this repository. It is also possible to use a version number like `0.1.0`. As soon as the commit is made, `Release Plugins` will be triggered in the action and the json file will be generated automatically. diff --git a/src/doc/tutorials/zh/011-about-deployment.tid b/src/doc/tutorials/zh/011-about-deployment.tid index ce6222e..0cb127c 100644 --- a/src/doc/tutorials/zh/011-about-deployment.tid +++ b/src/doc/tutorials/zh/011-about-deployment.tid @@ -1,4 +1,4 @@ -title: $:/plugins/Modern.TiddlyDev/doc/tutorials/zh/011-deployment-related information +title: $:/plugins/Modern.TiddlyDev/doc/tutorials/zh/011-deployment-related-information caption: [新手向]部署与下载 authors: mabuqian(马不前) type: text/vnd.tiddlywiki diff --git "a/src/doc/tutorials/zh/012-\345\205\263\344\272\216\350\260\203\350\257\225.tid" b/src/doc/tutorials/zh/012-about-debugging.tid similarity index 96% rename from "src/doc/tutorials/zh/012-\345\205\263\344\272\216\350\260\203\350\257\225.tid" rename to src/doc/tutorials/zh/012-about-debugging.tid index 28a566e..2e27312 100644 --- "a/src/doc/tutorials/zh/012-\345\205\263\344\272\216\350\260\203\350\257\225.tid" +++ b/src/doc/tutorials/zh/012-about-debugging.tid @@ -1,4 +1,4 @@ -title: $:/plugins/Modern.TiddlyDev/doc/tutorials/zh/012-关于调试 +title: $:/plugins/Modern.TiddlyDev/doc/tutorials/zh/012-about-debugging caption: 关于调试 authors: whitefall type: text/vnd.tiddlywiki diff --git a/src/doc/tutorials/zh/013-develop-more-plugins.tid b/src/doc/tutorials/zh/013-develop-more-plugins.tid new file mode 100644 index 0000000..3abac53 --- /dev/null +++ b/src/doc/tutorials/zh/013-develop-more-plugins.tid @@ -0,0 +1,17 @@ +title: $:/plugins/Modern.TiddlyDev/doc/tutorials/zh/develop-more-plugins +caption: 开发更多插件 +authors: mabuqian(马不前) +type: text/vnd.tiddlywiki + +同一个仓库里可以同时开发多个插件。这些插件可以归属于子插件，也可以是相关插件。这样就可以避免增加插件仓库，增加过多后期会维护比较难。 + +开发新的插件跟原来的插件使用到的命令是一样的。 + +`npm run new`或者`pnpm run new`，接下来只要填写相应的插件信息即可。同时会在`src`文件夹下生成一个新的插件文件夹。 + +插件开发完成后，可以提交到CPL上。提交流程则是打开[[CPL仓库|https://github.com/tiddly-gittly/TiddlyWiki-CPL]]，fork一份到自己的仓库中。然后下载下来用[[太记|https://github.com/tiddly-gittly/TidGi-Desktop]]打开。并添加一个新的插件条目。注意在URL字段中添加插件下载的仓库地址，一般形式为`https://github.com/tiddly-gittly/tiddlywiki-plugins/releases/latest/download/$plugin-name$.json`，这样CPL才会搜索到并下载这个插件。 + +之后提交PR到CPL仓库，等待管理员审核。审核通过后，就可以在自己的TiddlyWiki中搜索并下载这个插件了。 + +插件仓库需要发布release，这样CPL才能搜索到最新版本，并且需要按照`v.x.x.x`的格式命名。可以像本仓库一样使用类似`v2024.3.23-1`的版本号。也可以使用类似`0.1.0`的版本号。只要提交了，就会在action中触发`Release Plugins`并自动生成json文件。 +