Merge branch 'main' of https://github.com/deadlyjack/acode-plugin

Author: deadlyjack

readme.md

@@ -1,15 +1,39 @@
 # acode-plugin
 
 To create plugin for Acode editor use this template. To use this template create a github repository and add `https://github.com/deadlyjack/acode-plugin` as template.
+<details open>
+<summary><h2 style="display:inline;" id="toc">Table of Contents</h2></summary>
+
+* [Required Files of a plugin](#required-files)
+* [How to add a plugin to Acode](#add-your-plugin-to-acode)
+* [Available plugin references](#plugin-development)
+* [How to test a plugin](#testing)
+    - [Requirement](#requirement)
+* [Global APIs](#global-apis)
+    - [editorManager](#editormanager)
+    - [acode](#acode)
+    - [actionStack](#actionstack)
+    - [appSettings](#appsettings)
+        - [Events](#events)
+    - [Toast](#show-toast)
+    - [Data Storage](#data-storage)
+    - [Cache Storage](#cache-storage)
+* [Native APIs](#native-apis)
+    - [FsOperation](#fsoperation)
+    - [WcPage](#wcpage)
+
+</details>
 
 ## Required Files
 
+[:arrow_up: TOC](#toc)
+
 - plugin.json - contains information about the plugin.
 
   - id - plugin should have unique id. E.g. com.example.my-plugin
   - name - plugin name.
   - version - plugin version, if changes an update notificaiton will be sent to users.
-  - main - plugins main js file.
+  - main - path of plugin's main js file.
   - icon - plugin icon.
   - readme - readme file.
   - files - list of all files that are required by the plugin.
@@ -25,6 +49,8 @@ Transpile your javascript file using babel so that your plugin can work on older
 
 ## Add your plugin to Acode
 
+[:arrow_up: TOC](#toc)
+
 To add your plugin, fork [this](https://github.com/deadlyjack/acode-plugins) repository, clone it, add your plugin information to `list.json` and make a pull request.
 
 To initialize your plugin, use `acode.setPluginInit` method. This method requires two arguments.
@@ -46,30 +72,36 @@ You also need to set an unmount function, this is called when user choose to uni
 
 ## Plugin Development
 
-You can take reference from already available plugins [acode-plugin-python](https://github.com/deadlyjack/acode-plugin-python) and [acode-plugin-prettier](https://github.com/deadlyjack).
+You can take reference from already available plugins [acode-plugin-python](https://github.com/deadlyjack/acode-plugin-python), [acode-plugin-prettier](https://github.com/deadlyjack/acode-plugin-prettier) and [acode-plugin-snippets](https://github.com/deadlyjack/acode-plugin-snippets).
 
 ## Testing
 
+[:arrow_up: TOC](#toc)
+
 1. Open plugin project in VScode.
 
 2. Install 'live server' extension. Enable 'https' for live server and start the server
 
-3. Go to `settings > plugin > tap '+' icon in top right corner`.
+3. Open Acode and go to `settings > plugins > tap '+' icon in top right corner`.
 
-4. Add plugin locaion, e.g. https: &frasl; &frasl; 192.168.1.100:500 and click on install.
+4. Add plugin locaion, e.g. `https://192.168.1.100:500` and click on install.
 
 ### Requirement
 
 - [Nodejs](https://nodejs.org/en/)
 - Cordova
 - Android Studio
 
-## Global API
+## Global APIs
+
+[:arrow_up: TOC](#toc)
 
 The global variables that you can use them directly in your plugin.
 
 ### editorManager
 
+[:arrow_up: TOC](#toc)
+
 - `editor: AceAjax.Editor` [Ace editor](https://ace.c9.io/#nav=api&api=editor)
 - `addNewFile(filename?:string, options?): void` add a new file in workspace.
 
@@ -114,6 +146,8 @@ The global variables that you can use them directly in your plugin.
 
 ### acode
 
+[:arrow_up: TOC](#toc)
+
 - `exec(command: string, value: any)`
 - `setPluginInit(id: string, initfuntion(): void)`
 - `setPluginUnmount(id: string, unmountFunction(): void)`
@@ -122,6 +156,8 @@ The global variables that you can use them directly in your plugin.
 
 ### actionStack
 
+[:arrow_up: TOC](#toc)
+
 - `push(action: Object): void` Pushes a callback function to actionStack. When use tap on physical/virtual back button, the given callback function is triggered.
 
   - action
@@ -136,6 +172,8 @@ The global variables that you can use them directly in your plugin.
 
 ### appSettings
 
+[:arrow_up: TOC](#toc)
+
 - `value` all settings.
 - `on(event: string, listener(setting: any): void): void` attaches event listener.
 - `off(event: string, listener(setting: any): void): void` removes event listener.
@@ -161,6 +199,8 @@ Function `window.toast(msg: string, milliSecond: number): void` will show a toas
 
 ## Native APIs
 
+[:arrow_up: TOC](#toc)
+
 To access native features and method of device use these [plugins](https://github.com/deadlyjack/Acode/tree/main/src/plugins). For example to open a file using SAF
 
 ```javascript
@@ -180,6 +220,8 @@ To get more info api provided by these plugins see there `js` files in `www` dir
 
 ### FsOperation
 
+[:arrow_up: TOC](#toc)
+
 - `lsDir(): Promise<Array<Entry>>`
 - `readFile(encoding: string | ArrayBuffer): Promise<string | ArrayBuffer>`
 - `createFile(name: string, content?: string): Promise<string>`