Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add some docs #67

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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
Expand Down
17 changes: 17 additions & 0 deletions src/doc/tutorials/en/013-develop-more-plugins.tid
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion src/doc/tutorials/zh/011-about-deployment.tid
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
17 changes: 17 additions & 0 deletions src/doc/tutorials/zh/013-develop-more-plugins.tid
Original file line number Diff line number Diff line change
@@ -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文件。

Loading