Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inkdropapp/inkdrop-mobile-plugins
Plugins for Inkdrop mobile
https://github.com/inkdropapp/inkdrop-mobile-plugins
Last synced: 20 days ago
JSON representation
Plugins for Inkdrop mobile
- Host: GitHub
- URL: https://github.com/inkdropapp/inkdrop-mobile-plugins
- Owner: inkdropapp
- Created: 2020-01-08T07:59:41.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:29:01.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T14:54:18.272Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://docs.inkdrop.app/manual/plugin-for-mobile
- Size: 3.98 MB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Plugins for Inkdrop mobile
## How to add your plugin
### Update your plugin for mobile
#### Add `README-mobile.md`
It is a documentation for mobile.
Basically you can reuse your README.md but you have to remove sections for desktop like "How to install".
#### Remove "plugin" words from your plugin description
You can not use "plugin" or any words like "extension" in your package description or readme.
Because your plugin will be displayed as one of renderer options like so:
This is a workaround to avoid violating Apple's guideline.
Read [the blogpost](https://blog.inkdrop.info/a-promising-idea-towards-supporting-plugins-for-ios-app-5f7803715be7) for more detail on this workaround.
### Add submodule
Run the following command:
```sh
git submodule add packages/
```
### Edit `package.json`
Add your plugin to `devDependencies` like so:
```json
"devDependencies": {
"math": "file:packages/math",
}
```
Then, run `npm install`.
### Build
Run the following command:
```sh
npm run build
```
### Test
Add a test for your plugin to `test/index.js` to make sure it gets loaded properly.
For example:
```js
test.serial.cb("mermaid", t => {
global.window.inkdrop.packages.setPackageMainModule = (name, p) => {
t.is(name, "mermaid");
t.is(p instanceof Object, true);
t.is(typeof p.activate, "function");
t.is(typeof p.deactivate, "function");
t.end();
};
require("../lib/mermaid");
});
```
## How to debug your plugin
Build plugin metadata:
```sh
npm run build:index
```
Launch webpack server:
```sh
npm run dev:server
```
Then, open up a debugger tool:
[https://inkdrop-mobile-plugin-debugger.netlify.com/](https://inkdrop-mobile-plugin-debugger.netlify.com/)
Open Developer Tools and you should see like this:
