Skip to content

Commit cafa522

Browse files
authored
Improve create-plugin.md
1 parent 752258f commit cafa522

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

docs/getting-started/create-plugin.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,16 @@ Acode plugins follow a specific structure within a zip file. The necessary compo
2424
3. **readme.md:**
2525
- Contains the description or about plugin
2626

27+
3. **changelogs.md:**
28+
- contains changelogs of your plugin updates.
29+
2730
## Plugin Templates
2831

2932
To make your journey smoother, we provide comprehensive plugin templates, which are preconfigured and catering to various use cases:
3033

31-
1. **[JavaScript Template](https://github.com/deadlyjack/acode-plugin)** <Badge type="tip" text="official" /> : Javascript based template for plugin development and comes preconfigured
32-
33-
2. **[TypeScript Template](https://github.com/bajrangCoder/AcodeTSTemplate)** <Badge type="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)** <Badge type="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)** <Badge type="tip" text="official" /> : Javascript based template for plugin development and comes preconfigured
3835

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)** <Badge type="tip" text="official" /> : Typescript template for plugin development and comes with type checking and all typescript feature
4237

4338
## Getting Started
4439

@@ -79,23 +74,23 @@ To make your journey smoother, we provide comprehensive plugin templates, which
7974

8075
::: code-group
8176
```sh [npm]
82-
$ npm run start-dev
77+
$ npm run dev
8378
```
8479

8580
```sh [pnpm]
86-
$ pnpm start-dev
81+
$ pnpm dev
8782
```
8883

8984
```sh [yarn]
90-
$ yarn start-dev
85+
$ yarn dev
9186
```
9287

9388
```sh [bun]
94-
$ bun run start-dev
89+
$ bun run dev
9590
```
9691
:::
9792

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):
9994

10095
::: code-group
10196
```sh [npm]
@@ -118,11 +113,20 @@ To make your journey smoother, we provide comprehensive plugin templates, which
118113
5. **Install the Plugin:**
119114

120115
- 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.
121117
- Provide the plugin URL (e.g., `http://\<ip\>:3000/dist.zip`) when prompted.
122118
- Or if you are building manually then you can use the **Local** option in Acode's plugin manager and select the plugin zip
123119

124120
:::info
125-
Development server will only build the zip on file changes but for testing in 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.
126130
:::
127131
128132
## Building and Publishing
@@ -131,29 +135,29 @@ To share your plugin with the Acode community, follow these steps:
131135
132136
1. **Bundle for production:**
133137
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
135139
136140
::: code-group
137141
138142
```sh [npm]
139-
$ npm run build-release
143+
$ npm run build
140144
```
141145
142146
```sh [pnpm]
143-
$ pnpm build-release
147+
$ pnpm build
144148
```
145149
146150
```sh [yarn]
147-
$ yarn build-release
151+
$ yarn build
148152
```
149153
150154
```sh [bun]
151-
$ bun run build-release
155+
$ bun run build
152156
```
153157
154158
2. **Publish:**
155159
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.
157161

158162
- Tutorial for publishing a plugin : [Youtube](https://youtube.com/shorts/cxF2pxyN1HM?si=kQ5_BRtIO2RU-zhb)
159163

0 commit comments

Comments
 (0)