You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/create-plugin.md
+26-22Lines changed: 26 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,21 +24,16 @@ Acode plugins follow a specific structure within a zip file. The necessary compo
24
24
3.**readme.md:**
25
25
- Contains the description or about plugin
26
26
27
+
3.**changelogs.md:**
28
+
- contains changelogs of your plugin updates.
29
+
27
30
## Plugin Templates
28
31
29
32
To make your journey smoother, we provide comprehensive plugin templates, which are preconfigured and catering to various use cases:
30
33
31
-
1.**[JavaScript Template](https://github.com/deadlyjack/acode-plugin)** <Badgetype="tip"text="official" /> : Javascript based template for plugin development and comes preconfigured
32
-
33
-
2.**[TypeScript Template](https://github.com/bajrangCoder/AcodeTSTemplate)** <Badgetype="warning"text="community" /> : Typescript template for plugin development and comes with type checking and all typescript feature
34
-
35
-
3.**[Mobile Template](https://github.com/bajrangCoder/acode-plugin-template)** <Badgetype="warning"text="community" /> : Fork of official JavaScript Template with some tweaks and additional configuration to work on **Termux**
36
-
37
-
:::tip
34
+
1.**[JavaScript Template](https://github.com/Acode-Foundation/acode-plugin)** <Badgetype="tip"text="official" /> : Javascript based template for plugin development and comes preconfigured
38
35
39
-
[acode-cli](https://github.com/coswat/acode-cli) : A community driven cli tool to develop acode plugins easily. Its fast and easy to use and written in **rust**
40
-
41
-
:::
36
+
2.**[TypeScript Template](https://github.com/Acode-Foundation/AcodeTSTemplate)** <Badgetype="tip"text="official" /> : Typescript template for plugin development and comes with type checking and all typescript feature
42
37
43
38
## Getting Started
44
39
@@ -79,23 +74,23 @@ To make your journey smoother, we provide comprehensive plugin templates, which
79
74
80
75
::: code-group
81
76
```sh [npm]
82
-
$ npm run start-dev
77
+
$ npm run dev
83
78
```
84
79
85
80
```sh [pnpm]
86
-
$ pnpm start-dev
81
+
$ pnpm dev
87
82
```
88
83
89
84
```sh [yarn]
90
-
$ yarn start-dev
85
+
$ yarn dev
91
86
```
92
87
93
88
```sh [bun]
94
-
$ bun run start-dev
89
+
$ bun run dev
95
90
```
96
91
:::
97
92
98
-
- Or you can build every time manually on changes using:
93
+
- Or you can build every time manually on changes using(this will build production build):
99
94
100
95
::: code-group
101
96
```sh [npm]
@@ -118,11 +113,20 @@ To make your journey smoother, we provide comprehensive plugin templates, which
118
113
5. **Install the Plugin:**
119
114
120
115
- Use the **REMOTE** option in Acode's plugin manager.
116
+
- This option is available on both sidebar extension tab or on Plugin page from settings.
121
117
- Provide the plugin URL (e.g., `http://\<ip\>:3000/dist.zip`) when prompted.
122
118
- Or if you are building manually then you can use the **Local** option in Acode's plugin manager and selectthe plugin zip
123
119
124
120
:::info
125
-
Development server will only build the zip on file changes but fortestingin Acode, You will need to install plugin in Acode on changes to see effect
121
+
Development server will only build the zip on file changes
122
+
:::
123
+
124
+
:::tip
125
+
For local development, start a dev server using `npm run dev`. In Acode, use the **Remote** option, either from the **sidebar** or the **plugin page**. Enter the server URL, hit **Install**, and the plugin will be installed.
126
+
127
+
It's more convenient to manage this from the sidebar. When you install a local plugin(either using url or selecting the zip), Acode will add a **reload** icon in the **Extensions** tab of the sidebar. This is useful because the server automatically builds the plugin ZIP when changes are made. Simply press the reload button to apply the latest changes instantly.
128
+
129
+
This makes plugin development a much smoother experience—previously, it was quite frustrating, but this feature was recently added to improve the workflow.
126
130
:::
127
131
128
132
## Building and Publishing
@@ -131,29 +135,29 @@ To share your plugin with the Acode community, follow these steps:
131
135
132
136
1. **Bundle for production:**
133
137
134
-
- Use `build-release`command to create a production build. which will be lower in size
138
+
- Use `build` command to create a production build. which will be lower in size
135
139
136
140
::: code-group
137
141
138
142
```sh [npm]
139
-
$ npm run build-release
143
+
$ npm run build
140
144
```
141
145
142
146
```sh [pnpm]
143
-
$ pnpm build-release
147
+
$ pnpm build
144
148
```
145
149
146
150
```sh [yarn]
147
-
$ yarn build-release
151
+
$ yarn build
148
152
```
149
153
150
154
```sh [bun]
151
-
$ bun run build-release
155
+
$ bun run build
152
156
```
153
157
154
158
2. **Publish:**
155
159
156
-
- Publish your release build on [Acode's](https://acode.foxdebug.com) official website, making your plugin accessible to the broader community.
160
+
- Publish your release build on [Acode's](https://acode.app) official website, making your plugin accessible to the broader community.
157
161
158
162
- Tutorial for publishing a plugin : [Youtube](https://youtube.com/shorts/cxF2pxyN1HM?si=kQ5_BRtIO2RU-zhb)
0 commit comments