From 494fd121287f41e0736b0fedd1c594a3253a2e49 Mon Sep 17 00:00:00 2001 From: bjorn Date: Thu, 5 Apr 2018 12:24:56 +0200 Subject: [PATCH 1/2] Add `getting started` to the documentation. Fixes #613 --- documentation/index.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/documentation/index.md b/documentation/index.md index e6cf2c8b..d89b5117 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -26,6 +26,25 @@ Once a menu is registered, it cannot be altered. That means no commands can be a As of version 1.5 context menus can be created dynamically. That means the described behavior (once created, cannot be altered) still applies - but can be circumvented. Menus can be created on demand and they can be different depending on the triggering element. +## Getting started + +If you use NPM, install the `jquery-contextmenu` and include it in your build process. + +If you just want to load the library into your website you can either donwload the contents of the `dist` folder or use [cdnjs.com](https://cdnjs.com/libraries/jquery-contextmenu). + +``` + + + + +``` + +1. Download contents of the `dist` folder of this library to you project site, for example to `libs/contectmenu` +2. `` +3. `` +4. `` +5. `` + ## Features * trigger contextMenu with right-click, [left-click](demo/trigger-left-click.html), [hover](demo/trigger-hover.html) or own [custom trigger](demo/trigger-custom.html) events From efb90085b5da87cd568b974f36f3a220a757c384 Mon Sep 17 00:00:00 2001 From: bjorn Date: Tue, 10 Jul 2018 13:27:23 +0200 Subject: [PATCH 2/2] Fix small typo in docs --- documentation/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/index.md b/documentation/index.md index d89b5117..92dca1ab 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -39,11 +39,11 @@ If you just want to load the library into your website you can either donwload t ``` -1. Download contents of the `dist` folder of this library to you project site, for example to `libs/contectmenu` -2. `` -3. `` -4. `` -5. `` +1. Download contents of the `dist` folder of this library to you project site, for example to `scripts/contextmenu` +2. `` +3. `` +4. `` +5. `` ## Features