Completed Utilities section

Author: bajrangCoder

docs/utilities/ace-modes.md

@@ -1,17 +1,88 @@
 # Ace Modes
 
-:::warning
-**Note:** Work is in progress 🚧
+The Ace Modes is a utility method in Acode allows you to manage the language modes supported by the Ace editor. This includes adding new modes, removing existing ones, and configuring how the editor handles different file types.
+
+## Importing Ace Modes
+
+To use the Ace Modes utilities, you need to import them using the `acode.require` method:
+
+```javascript
+const aceModes = acode.require('aceModes');
+```
+
+## Methods
+
+### `addMode(name: string, extensions: string | string[], caption: string)`
+
+The `addMode` method adds a new mode to the Ace editor. This is useful when you want to support a custom language or file type.
+
+- **name**: The name of the mode.
+- **extensions**: The file extensions associated with this mode. This can be a string or an array of strings.
+- **caption**: The display name of the mode.
+
+#### Example
+
+```javascript
+const { addMode } = acode.require('aceModes');
+
+addMode('myMode', ['mymode', 'mym'], 'My Custom Mode');
+```
+
+:::info
+ The `extensions` parameter can be a single string or an array of strings, making it flexible to accommodate multiple file types.
 :::
 
-We are currently working on this section to provide you with detailed and comprehensive information about how Acode plugins work. Please check back soon for updates!
+### `removeMode(name: string)`
+
+The `removeMode` method removes a mode from the Ace editor. This is useful if you need to clean up or no longer need support for a particular mode.
+
+- **name**: The name of the mode to be removed.
 
-## Contribute to the Documentation
+#### Example
 
-We welcome contributions from the community! If you would like to help improve this documentation, please visit our [GitHub repository](https://github.com/bajrangCoder/acode-plugin-docs) and follow the contribution guidelines.
+```javascript
+const { removeMode } = acode.require('aceModes');
 
+removeMode('myMode');
+```
 :::tip
-You can suggest changes, add new content, or improve existing sections. Every bit of help is appreciated! 🤗
+Removing a mode that is no longer needed can help keep editor environment clean and efficient.
 :::
 
-For more information, see official [Guide](https://acode.app/plugin-docs).
+## Example
+
+Here’s a more detailed example that demonstrates how to add and remove a custom mode, and how to utilize these modes within the Ace editor.
+
+### Adding a Custom Mode
+
+Let's say you have a custom language with the extension `.mymode` and you want it to be recognized by the Ace editor.
+
+```javascript:line-numbers
+const aceModes = acode.require('aceModes');
+
+const onClick = () => {
+  // Action to perform when the menu item is clicked
+  console.log('Custom Mode Menu Item Clicked!');
+};
+
+// Adding the custom mode
+aceModes.addMode('myMode', ['mymode'], 'My Custom Mode');
+
+// Assuming you have the necessary mode definitions loaded for 'myMode'
+// Example of using the custom mode in the editor
+const editor = editorManager.editor;
+editor.session.setMode('ace/mode/myMode');
+```
+
+### Removing a Custom Mode
+
+If you decide to remove the custom mode from the Ace editor:
+
+```javascript:line-numbers
+const aceModes = acode.require('aceModes');
+
+// Removing the custom mode
+aceModes.removeMode('myMode');
+
+// The mode will no longer be available for use
+```

docs/utilities/encoding.md

@@ -1,17 +1,103 @@
 # Encoding
 
-:::warning
-**Note:** Work is in progress 🚧
-:::
+This allow to **encode** and **decode** strings with different character sets. This is especially useful when working with **files** that require specific encodings or when handling international text.
+
+## Importing Encodings
+
+To use the Encoding utilities, you need to import them using the `acode.require` method:
+
+```javascript
+const encodings = acode.require('encodings');
+```
+
+## Usage
+
+### Encoding a String
+
+The `encode` method converts a string into an ArrayBuffer using the specified character set.
+
+```javascript
+const text = 'Hello World!';
+const charset = 'utf-8';
+
+const encoded = await encodings.encode(text, charset);
+console.log(encoded);  // Output: ArrayBuffer
+```
+
+### Decoding an ArrayBuffer
+
+The `decode` method converts an ArrayBuffer back into a string using the specified character set.
+
+```javascript
+const buffer = await encodings.encode(text, charset);
+const decoded = await encodings.decode(buffer, charset);
+console.log(decoded);  // Output: 'Hello World!'
+```
+
+## Methods
+
+### `encode(text: string, charset: string): Promise<ArrayBuffer>`
+
+Encodes a string with the specified character set.
+
+- **text**: The text to encode.
+- **charset**: The character set name (e.g., UTF-8, GBK).
 
-We are currently working on this section to provide you with detailed and comprehensive information about how Acode plugins work. Please check back soon for updates!
+### `decode(buffer: ArrayBuffer, charset: string): Promise<string>`
 
-## Contribute to the Documentation
+Decodes an ArrayBuffer into a string using the specified character set.
 
-We welcome contributions from the community! If you would like to help improve this documentation, please visit our [GitHub repository](https://github.com/bajrangCoder/acode-plugin-docs) and follow the contribution guidelines.
+- **buffer**: The ArrayBuffer to decode.
+- **charset**: The character set name (e.g., UTF-8, GBK).
 
-:::tip
-You can suggest changes, add new content, or improve existing sections. Every bit of help is appreciated! 🤗
+## Properties
+
+### `encodings: Array<Encoding>`
+
+An array of all the supported encodings. Each `Encoding` object contains:
+
+- **name**: The name of the encoding.
+- **labels**: The labels of the encoding.
+- **aliases**: The aliases of the encoding.
+
+## Example
+
+Here is a comprehensive example demonstrating how to encode and decode text using different character sets.
+
+```javascript
+const encodings = acode.require('encodings');
+
+async function example() {
+  const text = 'Hello World!';
+  const charset = 'utf-8';
+
+  try {
+    // Encoding text
+    const encoded = await encodings.encode(text, charset);
+    console.log('Encoded:', encoded);
+
+    // Decoding text
+    const decoded = await encodings.decode(encoded, charset);
+    console.log('Decoded:', decoded);
+
+  } catch (error) {
+    console.error('Encoding/Decoding error:', error);
+  }
+}
+
+example();
+```
+
+:::info
+Always handle encoding and decoding within a try-catch block to manage potential errors, such as unsupported character sets.
 :::
 
-For more information, see official [Guide](https://acode.app/plugin-docs).
+### Checking Available Encodings
+
+You can check all the available encodings supported by Acode:
+
+```javascript
+console.log(encodings.encodings);
+```
+
+This will print an array of `Encoding` objects, each containing details about the encoding.