> For the complete documentation index, see [llms.txt](https://docs.haydejs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.haydejs.com/docs/how-to-create-custom-plugin.md).

# How to Create Custom Plugin

### (WIP)

Plugins are a way to extend the functionality of the framework. You can create your own plugins and use them in your projects.

### Plugin Structure

A plugin is a folder with the following structure:

```
plugin-name
├── index.js
├── package.json
```

### How easy is it to create a Plugin with Hayde

You can also create your plugin with Hayde. First, you need to create `.hayde.json` file in your project root. Then, add `createPlugin` **only** to the plugins array.

```json
{
  "plugins": [
    "createPlugin"
  ]
}
```

After that, you can run the following command to create your plugin.

```bash
npx hayde
```

#### index.js

This file is the entry point of the plugin. It should export;

* `pluginName`: Name of the plugin
* `initPlugin`: Init function of the plugin
* `runPlugin`: Run function of the plugin after everything is ready to go for parsing the component