UNPKG

@oeyoews/tiddlywiki-plugin-dev

Version:

[![](https://img.shields.io/badge/Join-TiddlyWiki_CN-blue)](https://github.com/tiddly-gittly)

tiddly-gittly.github.io/Modern.TiddlyDev/

93 lines (62 loc) • 2.79 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# tiddlywiki-plugin-dev [![](https://img.shields.io/badge/加入-太微_中文社区-blue)](https://github.com/tiddly-gittly) [English README](https://github.com/tiddly-gittly/plugin-dev-cli/blob/main/README.md) Tiddlywiki 插件开发工具, 与 [Modern.TiddlyDev](https://github.com/tiddly-gittly/Modern.TiddlyDev) 共同工作。 这是一个 npm 命令行工具，帮助开发者使用 TypeScript 开发、发布 [TiddlyWiki](https://tiddlywiki.com) 插件（如果你不会 TypeScript，也没有关系，可以把它当做一个简单易用的插件开发工具）。 ## 使用方法 该工具需要与 [Modern.TiddlyDev](https://github.com/tiddly-gittly/Modern.TiddlyDev) 一起使用，因此这里不过多介绍，详细使用方法请参考 [Modern.TiddlyDev 文档](https://tiddly-gittly.github.io/Modern.TiddlyDev)。 ### 命令提示 ```bash npx tiddlywiki-plugin-dev help ``` 输出： ``` Usage: tiddlywiki-plugin-dev [options] [command] Options: -h, --help display help for command Commands: dev Develop yout plugins with Modern.TiddlyDev build [options] Build plugins for Modern.TiddlyDev help [command] display help for command ``` ### 插件开发 根据你所编写的插件，启动一个 TiddlyWiki 服务进行测试。期间将时刻关注插件文件夹中的变化并自动刷新页面。 ```bash npx tiddlywiki-plugin-dev dev ``` 输出： ``` Compiling... ████████████████████████████████████████ 100% | plugin-name syncer-server-filesystem: Dispatching 'save' task: $:/StoryList Serving on http://127.0.0.1:8080 (press ctrl-C to exit) ``` ### 构建插件 #### 单独构建插件文件 ```bash npx tiddlywiki-plugin-dev build ``` 输出： ``` Compiling... ████████████████████████████████████████ 100% | plugin-name Minimized plugins 2.02 KiB $:/plugins/your-name/plugin-name ``` #### 构建插件库（发布给你的订阅者） ```bash npx tiddlywiki-plugin-dev build --library ``` 输出： ``` Compiling... ████████████████████████████████████████ 100% | plugin-name Minimized plugins 2.02 KiB $:/plugins/your-name/plugin-name Generating plugin library... syncer-server-filesystem: Dispatching 'save' task: $:/StoryList syncer-server-filesystem: Dispatching 'save' task: $:/UpgradeLibrary/List syncer-server-filesystem: Dispatching 'delete' task: $:/UpgradeLibrary syncer-server-filesystem: Dispatching 'delete' task: $:/UpgradeLibrary/List ```