https://github.com/mathieudutour/sketch-remove-bg
Remove the background of any image 100% automatically
https://github.com/mathieudutour/sketch-remove-bg
background bitmap remove sketch-plugin
Last synced: 7 months ago
JSON representation
Remove the background of any image 100% automatically
- Host: GitHub
- URL: https://github.com/mathieudutour/sketch-remove-bg
- Owner: mathieudutour
- Created: 2019-04-26T19:33:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T16:08:13.000Z (over 2 years ago)
- Last Synced: 2025-02-27T08:54:40.141Z (7 months ago)
- Topics: background, bitmap, remove, sketch-plugin
- Language: JavaScript
- Homepage:
- Size: 1.12 MB
- Stars: 139
- Watchers: 8
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Remove.bg Sketch plugin
_Remove image background in a single click_
## Installation
- [Download](../../releases/latest/download/remove-bg.sketchplugin.zip) the latest release of the plugin
- Un-zip
- Double-click on remove-bg.sketchplugin
## Development Guide
_This plugin was created using `skpm`. For a detailed explanation on how things work, checkout the [skpm Readme](https://github.com/skpm/skpm/blob/master/README.md)._
### Usage
Install the dependencies
```bash
npm install
```
Once the installation is done, you can run some commands inside the project folder:
```bash
npm run build
```
To watch for changes:
```bash
npm run watch
```
Additionally, if you wish to run the plugin every time it is built:
```bash
npm run start
```
### Custom Configuration
#### Babel
To customize Babel, you have two options:
- You may create a [`.babelrc`](https://babeljs.io/docs/usage/babelrc) file in your project's root directory. Any settings you define here will overwrite matching config-keys within skpm preset. For example, if you pass a "presets" object, it will replace & reset all Babel presets that skpm defaults to.
- If you'd like to modify or add to the existing Babel config, you must use a `webpack.skpm.config.js` file. Visit the [Webpack](#webpack) section for more info.
#### Webpack
To customize webpack create `webpack.skpm.config.js` file which exports function that will change webpack's config.
```js
/**
* Function that mutates original webpack config.
* Supports asynchronous changes when promise is returned.
*
* @param {object} config - original webpack config.
* @param {boolean} isPluginCommand - whether the config is for a plugin command or a resource
**/
module.exports = function(config, isPluginCommand) {
/** you can change config here **/
};
```
### Debugging
To view the output of your `console.log`, you have a few different options:
- Use the [`sketch-dev-tools`](https://github.com/skpm/sketch-dev-tools)
- Run `skpm log` in your Terminal, with the optional `-f` argument (`skpm log -f`) which causes `skpm log` to not stop when the end of logs is reached, but rather to wait for additional data to be appended to the input
### License
MIT
_All trademarks, service marks, trade names, product names, logos are the property of their respective owners._