LICENSE
3 years ago
README.md
3 years ago
jquery.magnific-popup.js
5 years ago
jquery.magnific-popup.min.js
5 years ago
magnific-popup.css
8 years ago
magnific-popup.min.css
8 years ago
README.md
77 lines
| 1 | # Magnific Popup Repository |
| 2 | |
| 3 | [](https://travis-ci.org/dimsemenov/Magnific-Popup](https://travis-ci.org/dimsemenov/Magnific-Popup](https://travis-ci.org/dimsemenov/Magnific-Popup) |
| 4 | [](https://flattr.com/thing/1310305/Magnific-Popup-by-dimsemenov](https://flattr.com/thing/1310305/Magnific-Popup-by-dimsemenov](https://flattr.com/thing/1310305/Magnific-Popup-by-dimsemenov) |
| 5 | |
| 6 | Fast, light and responsive lightbox plugin, for jQuery and Zepto.js. |
| 7 | |
| 8 | - [](http://dimsemenov.com/plugins/magnific-popup/documentation.htmlDocumentation and getting started guide](http://dimsemenov.com/plugins/magnific-popup/documentation.html](http://dimsemenov.com/plugins/magnific-popup/documentation.html). |
| 9 | - [](http://dimsemenov.com/plugins/magnific-popup/Examples and plugin home page](http://dimsemenov.com/plugins/magnific-popup/](http://dimsemenov.com/plugins/magnific-popup/). |
| 10 | - More examples in [](http://codepen.io/collection/nLcqoCodePen collection](http://codepen.io/collection/nLcqo](http://codepen.io/collection/nLcqo). |
| 11 | |
| 12 | Optionally, install via Bower `bower install magnific-popup` or npm: `npm install magnific-popup`. |
| 13 | [](https://rubygems.org/gems/magnific-popup-railsRuby gem](https://rubygems.org/gems/magnific-popup-rails](https://rubygems.org/gems/magnific-popup-rails): `gem install magnific-popup-rails`. |
| 14 | |
| 15 | ## Extensions |
| 16 | |
| 17 | - WordPress plugin - [](http://dimsemenov.com/plugins/magnific-popup/wordpress.htmlunder development](http://dimsemenov.com/plugins/magnific-popup/wordpress.html](http://dimsemenov.com/plugins/magnific-popup/wordpress.html). |
| 18 | - [](https://drupal.org/project/magnific_popupDrupal module](https://drupal.org/project/magnific_popup](https://drupal.org/project/magnific_popup). |
| 19 | - [](https://github.com/cdowdy/concrete5-Magnific-PopupConcrete5 add-on](https://github.com/cdowdy/concrete5-Magnific-Popup](https://github.com/cdowdy/concrete5-Magnific-Popup). |
| 20 | - [](http://www.redaxo.org/de/download/addons/?addon_id=1131Redaxo add-on](http://www.redaxo.org/de/download/addons/?addon_id=1131](http://www.redaxo.org/de/download/addons/?addon_id=1131). |
| 21 | - [](https://github.com/fritzmg/contao-magnific-popupContao extension](https://github.com/fritzmg/contao-magnific-popup](https://github.com/fritzmg/contao-magnific-popup). |
| 22 | |
| 23 | If you created an extension for some CMS, email me and I'll add it to this list. |
| 24 | |
| 25 | ## Location of stuff |
| 26 | |
| 27 | - Generated popup JS and CSS files are in folder [](https://github.com/dimsemenov/Magnific-Popup/tree/master/distdist/](https://github.com/dimsemenov/Magnific-Popup/tree/master/dist](https://github.com/dimsemenov/Magnific-Popup/tree/master/dist). (Online build tool is on [](http://dimsemenov.com/plugins/magnific-popup/documentation.htmldocumentation page](http://dimsemenov.com/plugins/magnific-popup/documentation.html](http://dimsemenov.com/plugins/magnific-popup/documentation.html)). |
| 28 | - Source files are in folder [](https://github.com/dimsemenov/Magnific-Popup/tree/master/srcsrc/](https://github.com/dimsemenov/Magnific-Popup/tree/master/src](https://github.com/dimsemenov/Magnific-Popup/tree/master/src). They include [](https://github.com/dimsemenov/Magnific-Popup/blob/master/src/css/main.scssSass CSS file](https://github.com/dimsemenov/Magnific-Popup/blob/master/src/css/main.scss](https://github.com/dimsemenov/Magnific-Popup/blob/master/src/css/main.scss) and js parts (edit them if you wish to submit commit). |
| 29 | - Website (examples & documentation) is in folder [](https://github.com/dimsemenov/Magnific-Popup/tree/master/websitewebsite/](https://github.com/dimsemenov/Magnific-Popup/tree/master/website](https://github.com/dimsemenov/Magnific-Popup/tree/master/website). |
| 30 | - Documentation page itself is in [](https://github.com/dimsemenov/Magnific-Popup/blob/master/website/documentation.mdwebsite/documentation.md](https://github.com/dimsemenov/Magnific-Popup/blob/master/website/documentation.md](https://github.com/dimsemenov/Magnific-Popup/blob/master/website/documentation.md) (contributions to it are very welcome). |
| 31 | |
| 32 | |
| 33 | |
| 34 | ## Using Magnific Popup? |
| 35 | |
| 36 | If you used Magnific Popup in some interesting way, or on site of popular brand, I'd be very grateful if you <a href='mailto:diiiimaaaa@gmail.com?subject="Site that uses Magnific Popup"'>email me</a> a link to it. |
| 37 | |
| 38 | |
| 39 | ## Build |
| 40 | |
| 41 | To compile Magnific Popup by yourself, first of make sure that you have [](http://nodejs.org/Node.js](http://nodejs.org/](http://nodejs.org/), [](https://github.com/cowboy/gruntGrunt.js](https://github.com/cowboy/grunt](https://github.com/cowboy/grunt), [](http://www.ruby-lang.org/Ruby](http://www.ruby-lang.org/](http://www.ruby-lang.org/) and [](https://github.com/mojombo/jekyll/Jekyll](https://github.com/mojombo/jekyll/](https://github.com/mojombo/jekyll/) installed, then: |
| 42 | |
| 43 | 1) Copy repository |
| 44 | |
| 45 | git clone https://github.com/dimsemenov/Magnific-Popup.git |
| 46 | |
| 47 | 2) Go inside Magnific Popup folder that you fetched and install Node dependencies |
| 48 | |
| 49 | cd Magnific-Popup && npm install |
| 50 | |
| 51 | 3) Now simply run `grunt` to generate JS and CSS in folder `dist` and site in folder `_site/`. |
| 52 | |
| 53 | grunt |
| 54 | |
| 55 | Optionally: |
| 56 | |
| 57 | - Run `grunt watch` to automatically rebuild script when you change files in `src/` or in `website/`. |
| 58 | - If you don't have and don't want to install Jekyll, run `grunt nosite` to just build JS and CSS files related to popup in `dist/`. |
| 59 | |
| 60 | |
| 61 | |
| 62 | ## [](https://github.com/dimsemenov/Magnific-Popup/releasesChangelog](https://github.com/dimsemenov/Magnific-Popup/releases](https://github.com/dimsemenov/Magnific-Popup/releases) |
| 63 | |
| 64 | ## License |
| 65 | |
| 66 | Script is MIT licensed and free and will always be kept this way. But has a small restriction from me - please do not create public WordPress plugin based on it(or at least contact me before creating it), because I will make it and it'll be open source too ([](http://dimsemenov.com/subscribe.htmlwant to get notified?](http://dimsemenov.com/subscribe.html](http://dimsemenov.com/subscribe.html)). |
| 67 | |
| 68 | Created by [](http://twitter.com/dimsemenov@dimsemenov](http://twitter.com/dimsemenov](http://twitter.com/dimsemenov) & [](https://github.com/dimsemenov/Magnific-Popup/contributorscontributors](https://github.com/dimsemenov/Magnific-Popup/contributors](https://github.com/dimsemenov/Magnific-Popup/contributors). |
| 69 | |
| 70 | [](https://bitdeli.com/free "Bitdeli Badge"](https://bitdeli.com/free "Bitdeli Badge"](https://bitdeli.com/free "Bitdeli Badge") |
| 71 | |
| 72 | ## Bugs & contributing |
| 73 | |
| 74 | Please report bugs via GitHub and ask general questions through [](http://stackoverflow.com/questions/tagged/magnific-popupStack Overflow](http://stackoverflow.com/questions/tagged/magnific-popup](http://stackoverflow.com/questions/tagged/magnific-popup). Feel free to submit commit [](https://github.com/dimsemenov/Magnific-Popup/pullspull-request](https://github.com/dimsemenov/Magnific-Popup/pulls](https://github.com/dimsemenov/Magnific-Popup/pulls), even the tiniest contributions to the script or to the documentation are very welcome. |
| 75 | |
| 76 | |
| 77 |