https://github.com/imdone/imdone-api
Imdone plugin api: Frictionless kanban for your markdown and code
https://github.com/imdone/imdone-api
Last synced: 6 months ago
JSON representation
Imdone plugin api: Frictionless kanban for your markdown and code
- Host: GitHub
- URL: https://github.com/imdone/imdone-api
- Owner: imdone
- License: mit
- Created: 2021-11-17T14:42:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T01:40:17.000Z (over 1 year ago)
- Last Synced: 2025-10-20T19:55:43.317Z (9 months ago)
- Language: TypeScript
- Homepage: https://imdone.github.io/imdone-api/
- Size: 204 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# imdone-api
A plugin api for [imdone: Kanban for Developers: In Your Markdown and Code](https://imdone.io/).
## Creating a plugin for Imdone
1. Create a `plugins` folder under your project's `.imdone` folder.
`/my/project/path/.imdone/plugins`
1. Create a folder for your plugin under `plugins` and give it a name like `MyPlugin`.
My directory structure looks like this...
```bash
.imdone
├── config.yml
└── plugins
└── myPlugin
├── index.js
├── node_modules
├── package-lock.json
└── package.json
```
1. Look at [imdone/imdone-sample-plugin: A sample plugin for Imdone](https://github.com/imdone/imdone-sample-plugin) for inspiration.
1. Review the plugin [api docs](https://imdone.github.io/imdone-api/)
2. To make your plugin available for all imdone users, open a PR at [imdone/imdone-plugins](https://github.com/imdone/imdone-plugins).
## Naming your plugin
To identify your plugin imdone requires an implementation of the Plugin class `get pluginName` method. This method should return a string that is the name of your plugin. The name should follow these guidelines:
- Use camelCase for the name of your plugin. For example, `myPlugin`.
- Don't use the name `imdone` in your plugin name. This is reserved for the imdone core.
- Use a name that describes what your plugin does.
- Use a name that is unique to your plugin. This will help avoid conflicts with other plugins.
## Join the discussion on [discord](https://discord.gg/ZAETw2dC)