https://github.com/zcallan/sketch-bacon-ipsum
A simple & easy Bacon Ipsum text generator for Sketch.
https://github.com/zcallan/sketch-bacon-ipsum
bacon ipsum lorem plugin sketch
Last synced: 9 days ago
JSON representation
A simple & easy Bacon Ipsum text generator for Sketch.
- Host: GitHub
- URL: https://github.com/zcallan/sketch-bacon-ipsum
- Owner: zcallan
- License: mit
- Created: 2018-03-05T00:04:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-13T13:27:02.000Z (over 8 years ago)
- Last Synced: 2025-02-28T17:57:15.825Z (over 1 year ago)
- Topics: bacon, ipsum, lorem, plugin, sketch
- Language: JavaScript
- Homepage:
- Size: 216 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sketch-bacon-ipsum
_Credits to [Bacon Ipsum](https://baconipsum.com) for the API and image._
## Install
Download the latest release of this plugin under [the Releases tab in this repository](https://github.com/zcallan/sketch-bacon-ipsum/releases/latest).
Unzip the downloaded file, and double click on the `.sketchplugin` file.
You should automatically see `Bacon Ipsum` under your Plugins menu in Sketch, where by clicking it you can populate any piece of text with some juicy Bacon Ipsum.
Let me know if there are any issues.
## Development
_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 - wether 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)
* Open `Console.app` and look for the sketch logs
* Look at the `~/Library/Logs/com.bohemiancoding.sketch3/Plugin Output.log` file
Skpm provides a convenient way to do the latter:
```bash
skpm log
```
The `-f` option 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
This project is licensed under the terms of the MIT license.