copy README from uikit repo for typedoc porposes and quick update to documentation comments

2026-02-06 19:07:08 +00:00 · 2015-10-17 16:50:59 -03:00 · 2015-10-17 16:50:59 -03:00 · dc2c33d3fa
commit dc2c33d3fa
parent d1601626fd
3 changed files with 111 additions and 3 deletions
--- a/uikit/README.md
+++ b/uikit/README.md
@ -0,0 +1,88 @@
+# UIkit
+
+UIkit is a lightweight and modular front-end framework for developing fast and powerful web interfaces.
+
+* [Homepage](http://getuikit.com) - Learn more about UIkit
+* [@getuikit](https://twitter.com/getuikit) - Get the latest buzz on Twitter
+* [Google+ Community](https://plus.google.com/communities/114238665434626719878) - Share news and latest work
+
+Join our developer chat. We are online every work day between 8:00 and 18:00 UTC
+
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/uikit/uikit)
+
+## Getting started
+
+You have following options to get UIkit:
+
+- Download the [latest release](https://github.com/uikit/uikit/releases/latest)
+- Clone the repo, `git clone git://github.com/uikit/uikit.git`.
+- Install with [Bower](http://bower.io): ```bower install uikit```
+
+You find the compiled UIkit distribution in its own [repo](https://github.com/uikit/bower-uikit).
+
+## Developers
+
+First of all, install [Node](http://nodejs.org/). We use [Gulp](http://gulpjs.com) to build UIkit. If you haven't used Gulp before, you need to install the `gulp` package as a global install.
+
+```
+npm install --global gulp
+```
+
+If you haven't done so already, clone the UIkit git repo.
+
+```
+git clone git://github.com/uikit/uikit.git
+```
+Install the Node dependencies.
+
+```
+cd uikit
+npm install
+```
+
+Run `gulp` to lint, build and minify the release.
+
+```
+gulp [-t themename]
+```
+
+The built version of UIkit will be put in the `/dist` subdirectory. Pass a theme name parameter to only build the specified theme.
+
+### Browsersync
+
+```
+gulp sync
+```
+
+After running `gulp sync` a new browser instance will open, pointing to the uikit folder - `http://localhost:3000/`. The browser window will reload anytime you modify a source file.
+
+### Custom prefix
+
+Run gulp with your own prefix parameter ```-p``` to have all classes and JavaScript files custom prefixed.
+
+```
+gulp -p myprefix
+```
+
+
+## Contributing
+
+UIkit follows the [GitFlow branching model](http://nvie.com/posts/a-successful-git-branching-model). The ```master``` branch always reflects a production-ready state while the latest development is taking place in the ```develop``` branch.
+
+Each time you want to work on a fix or a new feature, create a new branch based on the ```develop``` branch: ```git checkout -b BRANCH_NAME develop```. Only pull requests to the ```develop``` branch will be merged.
+
+## Versioning
+
+UIkit is maintained by using the [Semantic Versioning Specification (SemVer)](http://semver.org).
+
+## Browser Support
+
+![Chrome](https://raw.github.com/alrra/browser-logos/master/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/firefox/firefox_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/internet-explorer/internet-explorer_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/safari/safari_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/opera/opera_48x48.png)
+--- | --- | --- | --- | --- |
+Latest ✔ | Latest ✔ | 9+ ✔ | 7.1+ ✔ | Latest ✔ |
+
+Tested with [BrowserStack](https://www.browserstack.com) (thanks for sponsoring!).
+
+## Copyright and License
+
+Copyright [YOOtheme](http://www.yootheme.com) GmbH under the [MIT license](LICENSE.md).
--- a/uikit/uikit-tests.ts
+++ b/uikit/uikit-tests.ts
@ -1,5 +1,5 @@
 /// <reference path="uikit.d.ts" />
-import StickyOptions = UIkit.StickyOptions;
+
 function testModal() {
    UIkit.modal.alert("Attention!");
    UIkit.modal.confirm("Are you sure?", function () {
@ -30,7 +30,7 @@ function testLightBox() {
    var element = "#group";
    var lightbox = UIkit.lightbox(element, {/* options */});
    var lightbox2 = UIkit.lightbox.create([
-        {'source': 'http://url/to/video.mp4', 'type': 'video'},
+        {source: 'http://url/to/video.mp4', 'type': 'video'},
        {'source': 'http://url/to/image.jpg', 'type': 'image'}
    ]);
    lightbox2.show();
--- a/uikit/uikit.d.ts
+++ b/uikit/uikit.d.ts
@ -101,6 +101,7 @@ declare module UIkit {
    }
    /**
     * Create a smooth off-canvas sidebar that slides in and out of the page
+     * Documentation: {@link http://getuikit.org/docs/offcanvas.html}
     * <h2>Events:</h2>
     * <table class="uk-table uk-table-striped uk-text-nowrap">
     * <tr>
@ -163,6 +164,7 @@ declare module UIkit {
    }
    /**
     * Create a fancy lightbox for images and videos utilizing the @see {@link modal|Modal Component}
+     * Documentation {@link http://getuikit.org/docs/lightbox.html}
     * <h2>Events:</h2>
     * <table>
     * <tr>
@ -215,6 +217,7 @@ declare module UIkit {
    }
    /**
     * Create inputs that allow users to choose from a list of pre-generated values while typing
+     * Documentation {@link http://getuikit.org/docs/autocomplete.html}
     * <h2>Events</h2>
     * <table>
     * <tr>
@ -290,6 +293,7 @@ declare module UIkit {
    }
    /**
     * Create a toggleable dropdown with an datepicker
+     * Documentation {@link http://getuikit.org/docs/datepicker.html}
     * <h2>Events</h2>
     * <table>
     * <tr>
@ -350,6 +354,10 @@ declare module UIkit {
         */
        lblCodeview?: string
    }
+    /**
+     * Create a rich HTML or markdown editor with an immediate preview and syntax highlighting
+     * Documentation {@link http://getuikit.org/docs/htmleditor.html}
+     */
    interface HtmlEditor {
        /**
         * Init element manually
@ -397,6 +405,7 @@ declare module UIkit {
    }
    /**
     * Create a list of items to use as a responsive carousel slider
+     * Documentation {@link http://getuikit.org/docs/slider.html}
     * <h2>Events</h2>
     * <table class="uk-table uk-table-striped uk-text-nowrap">
     * <tr>
@ -483,7 +492,7 @@ declare module UIkit {
    }
    /**
     * Create sets and groups of items, allowing to loop through the sets.
-     *
+     * Documentation {@link http://getuikit.org/docs/slideset.html}
     * <h2>Events</h2>
     * <table>
     * <tr>
@ -582,6 +591,7 @@ declare module UIkit {
    }
    /**
     * Create a responsive image or video slideshow with stunning transition effects, fullscreen mode and overlays.
+     * Documentation {@link http://getuikit.org/docs/slideshow.html}
     * <h2>Events</h2>
     * <table>
     * <tr>
@ -634,6 +644,7 @@ declare module UIkit {
    }
    /**
     * Animate CSS properties depending on the scroll position of the document.
+     * Documentation {@link http://getuikit.org/docs/parallax.html}
     */
    interface Parallax {
        /**
@ -703,6 +714,7 @@ declare module UIkit {
    }
    /**
     * Create a list of items, allowing each item's content to be expanded and collapsed by clicking its header.
+     * Documentation {@link http://getuikit.org/docs/accordion.html}
     * <h2>Events</h2>
     * <table class="uk-table uk-table-striped uk-text-nowrap">
     * <tr>
@ -759,6 +771,7 @@ declare module UIkit {
    }
    /**
     * Create toggleable notifications that fade out automatically
+     * Documentation {@link http://getuikit.org/docs/notify.html}
     */
    interface Notify {
        /**
@ -820,6 +833,7 @@ declare module UIkit {
    }
    /**
     * Easily create a nicely looking search.
+     * Documentation {@link http://getuikit.org/docs/search.html}
     */
    interface Search {
        /**
@ -947,6 +961,7 @@ declare module UIkit {
    }
    /**
     * Create nestable lists that can be sorted by drag and drop.
+     * Documentation {@link http://getuikit.org/docs/nestable.html}
     * <h2>Events</h2>
     * <table>
     * <tr>
@ -1024,6 +1039,7 @@ declare module UIkit {
    }
    /**
     * Create sortable grids and lists to rearrange the order of its elements.
+     * Documentation {@link http://getuikit.org/docs/sortable.html}
     * <h2>Events</h2>
     * <table class="uk-table uk-table-striped uk-text-nowrap">
     * <tr>
@ -1136,6 +1152,7 @@ declare module UIkit {
    }
    /**
     * Make elements remain at the top of the viewport, like a sticky navbar.
+     * Documentation {@link http://getuikit.org/docs/sticky.html}
     * <h2>Events</h2>
     * <table class="uk-table uk-table-striped uk-text-nowrap">
     * <tr>
@ -1189,6 +1206,7 @@ declare module UIkit {
    }
    /**
     * Create a timepicker which can easily be used by selecting a time value from a pre filled dropdown.
+     * Documentation {@link http://getuikit.org/docs/timepicker.html}
     */
    interface Timepicker {
        /**
@ -1245,6 +1263,7 @@ declare module UIkit {
    }
    /**
     * Easily create a nicely looking tooltip.
+     * Documentation {@link http://getuikit.org/docs/tooltip.html}
     */
    interface Tooltip {
        /**
@ -1321,6 +1340,7 @@ declare module UIkit {

    /**
     * Allow users to upload files through a file input form element or a placeholder area.
+     * Documentation {@link http://getuikit.org/docs/upload.html}
     * <h2>Callbacks</h2>
     * <table class="uk-table uk-table-striped">
     * <tr>