-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
|  | ||
| # Lorem Ipsum plugin for Adobe XD | ||
| > Add placeholder text. As simple as you want it to be, yet as advanced as you need it to be... | ||
| [](https://github.com/pklaschka/lorem-ipsum-plugin/actions?query=branch%3Amaster+workflow%3ACI) | ||
| [](https://coveralls.io/github/pklaschka/lorem-ipsum-plugin?branch=refs/head/coveralls) | ||
|  | ||
|
|
@@ -11,38 +13,46 @@ | |
|
|
||
| Official repository for the Lorem Ipsum plugin for Adobe XD. | ||
|
|
||
| ## Setup | ||
| Once you've cloned the repo, you merely need to run `npm install` in the root folder of the (cloned) project from your console. After that, you'll need to adjust the `manifest.json` in the `dist` folder and after that, you're ready to go. | ||
| ## Plugin Description | ||
| A small plugin to insert placeholder text that fits your needs: As simple as you want it to be, yet as advanced as you need it to be… | ||
|
|
||
| It is as easy as selecting one or more text layer(s) and running the plugin from the plugin's menu. Alternatively, you can also use the keyboard shortcut "Ctrl+Alt+L" on Windows or "Cmd+Option+L" on macOS to run the plugin. | ||
|
|
||
| Last but not least: I’m always happy to listen to feedback. Therefore, if you have any (may it be feature requests, bug reports or something else), please let me know via the support website, and I'll see how I can accommodate your wishes. | ||
|
|
||
| ## Development | ||
| ### Setup | ||
| Once you've cloned the repo, you merely need to run `npm install` in the root folder of the (cloned) project from your console. | ||
|
|
||
| ## Usage | ||
| ### Usage | ||
| The main two folders you'll be working in are the `src` folder (where all your JavaScript source code gets into) as well as the `dist` folder, which is where your code gets compiled into and where you'll need to put all the "static" resources (like images, icons etc. – also your manifest.json file is here). | ||
|
|
||
| It is the `dist` folder that gets compiled into your `.xdx` plugin and what provides your 'valid' plugin code. | ||
|
|
||
| ## Commands | ||
| ### Commands | ||
|
|
||
| ### `npm run build` | ||
| #### `npm run build` | ||
| This will build (i.e. compile) your plugin and automatically generate a `dist.xdx` file which can be found in the root folder and is ready to get submitted for review in the Adobe developer console. | ||
|
|
||
| ### `npm run compile` | ||
| #### `npm run compile` | ||
| Does the exact same thing as `npm run build`, but does **not** generate a `dist.xdx` file (and only compiles your plugin so it "lives" in your `dist` folder). | ||
|
|
||
| ### `npm run debug:install` | ||
| #### `npm run debug:install` | ||
| This will build (or compile) your plugin and install it in the development folder of Adobe XD once. Please note that this uses the development mode when compiling, making mistakes easier to find. This, however, means your plugin won't get minified. | ||
|
|
||
| ### `npm run debug:watch` or `npm start` | ||
| #### `npm run debug:watch` or `npm start` | ||
| Does the same as `npm run debug:install`, but watches the file system for changes and automatically recompiles and reinstalls the plugin when anything's changed (extremely useful during development). | ||
|
|
||
| Please note that you'll still need to run the "Reload plugins" command inside Adobe XD after every new install (may that be via `debug:install` or every time via `debug:watch`). | ||
|
|
||
| ### `npm run lint` | ||
| #### `npm run lint` | ||
| Runs the ESLint linter on the `src` folder to check for style errors in your code. | ||
|
|
||
| ## Setting up different editors and IDEs | ||
| ### Visual Studio Code | ||
| ### Setting up different editors and IDEs | ||
| #### Visual Studio Code | ||
| The project should work out of the box in Visual Studio Code, no further configuration should be required. | ||
|
|
||
| ### JetBrains WebStorm | ||
| #### JetBrains WebStorm | ||
| Activate node autocompletion (Preferences=>Languages & Frameworks=>Node.js and npm=>Enable) | ||
|
|
||
| ## Attribution | ||
|
|
||