docs(all): Updated docs using grunt-chalkboard v0.2.2

angular-macgyver · Jan 10, 2014 · a34990f · a34990f
1 parent 906f573
commit a34990f
Show file tree

Hide file tree

Showing 31 changed files with 73 additions and 16 deletions.
diff --git a/docs/directives/affix.md b/docs/directives/affix.md
@@ -3,6 +3,7 @@ mac-affix
 ===
 Fix the component at a certain position  
 
+
 ### Parameters
 **mac-affix-disabled**  
 Type: `Expr`  

diff --git a/docs/directives/autocomplete.md b/docs/directives/autocomplete.md
@@ -3,8 +3,10 @@ Autocomplete
 ===
 A directive for providing suggestions while typing into the field  
 
+
 ### Dependencies
 - mac-menu  
+
 
 ### Parameters
 **ng-model**  
@@ -30,21 +32,21 @@ Boolean value if autocomplete should be disabled
 **mac-autocomplete-on-select**  
 Type: `Function`  
 Function called when user select on an item  
-- `selected` - {Object} The item selected  
+       - `selected` - {Object} The item selected  
 
 **mac-autocomplete-on-success**  
 Type: `Function`  
 function called on success ajax request  
-- `data` - {Object} Data returned from the request  
-- `status` - {Number} The status code of the response  
-- `header` - {Object} Header of the response  
+        - `data` - {Object} Data returned from the request  
+        - `status` - {Number} The status code of the response  
+        - `header` - {Object} Header of the response  
 
 **mac-autocomplete-on-error**  
 Type: `Function`  
 Function called on ajax request error  
-- `data` - {Object} Data returned from the request  
-- `status` - {Number} The status code of the response  
-- `header` - {Object} Header of the response  
+        - `data` - {Object} Data returned from the request  
+        - `status` - {Number} The status code of the response  
+        - `header` - {Object} Header of the response  
 
 **mac-autocomplete-label**  
 Type: `String`  

diff --git a/docs/directives/cspinner.md b/docs/directives/cspinner.md
@@ -4,6 +4,7 @@ Canvas Spinner
 A directive for generating a canvas spinner  
 This spinner requires much less CPU/GPU resources than CSS spinner  
 
+
 ### Parameters
 **mac-cspinner-width**  
 Type: `Integer`  

diff --git a/docs/directives/datepicker.md b/docs/directives/datepicker.md
@@ -3,9 +3,11 @@ Datepicker
 ===
 A directive for creating a datepicker on text input using jquery ui  
 
+
 ### Dependencies
 - jQuery  
 - jQuery datepicker  
+
 
 ### Parameters
 **mac-datepicker-id**  
@@ -20,14 +22,14 @@ Clearing model by setting it to null or '' will clear the input field
 **mac-datepicker-on-select**  
 Type: `Function`  
 Function called before setting the value to the model  
-- `date` - {String} Selected date from the datepicker  
-- `instance` - {Object} Datepicker instance  
+  - `date` - {String} Selected date from the datepicker  
+  - `instance` - {Object} Datepicker instance  
 
 **mac-datepicker-on-close**  
 Type: `String`  
 Function called before closing datepicker  
-- `date` - {String} Selected date from the datepicker  
-- `instance` - {Object} Datepicker instance  
+  - `date` - {String} Selected date from the datepicker  
+  - `instance` - {Object} Datepicker instance  
 
 **mac-datepicker-append-text**  
 Type: `String`  

diff --git a/docs/directives/events/base.md b/docs/directives/events/base.md
@@ -4,6 +4,7 @@ Events
 A directive for handling basic html events (e.g., blur, keyup, focus, etc.)  
 Currently MacGyver has blur, focus, keydown, keyup, mouseenter and mouseleave  
 
+
 ### Parameters
 **mac-blur**  
 Type: `Expression`  

diff --git a/docs/directives/events/keydown.md b/docs/directives/events/keydown.md
@@ -4,6 +4,7 @@ Keydown events
 A directive for handling certain keys on keydown event  
 Currently MacGyver supports enter, escape, space, left, up, right and down  
 
+
 ### Parameters
 **mac-keydown-enter**  
 Type: `Expression`  

diff --git a/docs/directives/events/pause_typing.md b/docs/directives/events/pause_typing.md
@@ -3,6 +3,7 @@ Pause Typing
 ===
 macPauseTyping directive allow user to specify custom behavior after user stops typing for more than (delay) milliseconds  
 
+
 ### Parameters
 **mac-pause-typing**  
 Type: `Expression`  

diff --git a/docs/directives/events/window_resize.md b/docs/directives/events/window_resize.md
@@ -3,6 +3,7 @@ Windows Resize
 ===
 Binding custom behavior on window resize event  
 
+
 ### Parameters
 **mac-window-resize**  
 Type: `Expression`  

diff --git a/docs/directives/file_upload.md b/docs/directives/file_upload.md
@@ -3,9 +3,11 @@ File upload
 ===
 Directive for proxying jQuery file upload  
 
+
 ### Dependencies
 - jQuery  
 - jQuery file upload  
+
 
 ### Parameters
 **mac-upload-route**  

diff --git a/docs/directives/focus_on_event.md b/docs/directives/focus_on_event.md
@@ -3,6 +3,7 @@ mac-focus-on-event
 ===
 Scroll window to the element and focus on the element  
 
+
 ### Parameters
 **mac-focus-on-event**  
 Type: `String`  

diff --git a/docs/directives/menu.md b/docs/directives/menu.md
@@ -3,16 +3,17 @@ Menu
 ===
 A directive for creating a menu with multiple items  
 
+
 ### Parameters
 **mac-menu-items**  
 Type: `Expression`  
 List of items to display in the menu  
-Each item should have a `label` key as display text  
+        Each item should have a `label` key as display text  
 
 **mac-menu-select**  
 Type: `Function`  
 Callback on select  
-- `index` - {Integer} Item index  
+        - `index` - {Integer} Item index  
 
 **mac-menu-style**  
 Type: `Object`  

diff --git a/docs/directives/modal.md b/docs/directives/modal.md
@@ -4,6 +4,7 @@ mac-modal (element)
 Element directive to define the modal dialog. Modal content is transcluded into a  
 modal template  
 
+
 ### Parameters
 **mac-modal-keyboard**  
 Type: `Boolean`  

diff --git a/docs/directives/placeholder.md b/docs/directives/placeholder.md
@@ -3,6 +3,7 @@ Placeholder
 ===
 Dynamically fill out the placeholder text of input  
 
+
 ### Parameters
 **mac-placeholder**  
 Type: `String`  

diff --git a/docs/directives/scroll_spy.md b/docs/directives/scroll_spy.md
@@ -3,6 +3,7 @@ mac-scroll-spy
 ===
 Element to spy scroll event on  
 
+
 ### Parameters
 **mac-scroll-spy-offset**  
 Type: `Integer`  

diff --git a/docs/directives/spinner.md b/docs/directives/spinner.md
@@ -3,6 +3,7 @@ Spinner
 ===
 A directive for generating spinner  
 
+
 ### Parameters
 **mac-spinner-size**  
 Type: `Integer`  

diff --git a/docs/directives/table/mac_columns.md b/docs/directives/table/mac_columns.md
@@ -4,6 +4,7 @@ Columns
 Directive that keeps track of the widths of the columns in the table.  
 This directive is automatically added to any row whose cells use `mac-columns-width`.  
 
+
 ### Dependencies
 macTable, macTableSection, macTableRow  
 
diff --git a/docs/directives/table/table_cell.md b/docs/directives/table/table_cell.md
@@ -3,8 +3,10 @@ Cell Template
 ===
 Directive for assigning cell templates to table columns  
 
+
 ### Dependencies
 macTable, macTableSection, macTableRow  
+
 
 ### Parameters
 **mac-cell-template**  

diff --git a/docs/directives/table/table_row.md b/docs/directives/table/table_row.md
@@ -3,6 +3,7 @@ Table Row
 ===
 Directive initializing a table row for cell templates to be registered under  
 
+
 ### Dependencies
 macTable, macTableSection  
 
diff --git a/docs/directives/table/table_section.md b/docs/directives/table/table_section.md
@@ -4,6 +4,7 @@ Table Section
 Main directive for registering table sections. Can optionally have   
 macTableSectionModels, macTableSectionController, or macTableSectionBlankRow.  
 
+
 ### Dependencies
 macTable  
 
@@ -13,6 +14,7 @@ Table Section Blank Row
 
 Inserts a blank row with keys matching those of the tables columns.  
 
+
 ### Dependencies
 macTable, macTableSection  
 
@@ -22,6 +24,7 @@ Table Section Models
 
 Watches a models expression and loads them into the section  
 
+
 ### Dependencies
 macTable, macTableSection  
 
@@ -31,6 +34,7 @@ Table Section Controller
 
 Watches a controller expression and loads the controller into the section  
 
+
 ### Dependencies
 macTable, macTableSection  
 
diff --git a/docs/directives/table/table_section_selected_models.md b/docs/directives/table/table_section_selected_models.md
@@ -3,11 +3,13 @@ Table Section Selected Models
 ===
 Creates two way binding between a selected models array  
 
+
 ### Parameters
 **mac-table-section-selected-models**  
 Type: `array`  
 A two-way bound array to see selected models and to select them   
 
+
 
 ### Dependencies
 macTable, macTableSection  
@@ -18,11 +20,13 @@ Table Selectable
 
 Gives element it is on a click event that selects the row it shares a scope with  
 
+
 ### Parameters
 **mac-table-selectable**  
 Type: `bool`  
 whether the current element is selectable  
 
+
 
 ### Dependencies
 macTable, macTableSection, macTableSectionSelectedModels  

diff --git a/docs/directives/table/table_view.md b/docs/directives/table/table_view.md
@@ -3,6 +3,7 @@ Table
 ===
 Directive for displaying tabluar data  
 
+
 ### Parameters
 **mac-table-resizable-columns**  
 Type: `None`  
@@ -12,4 +13,5 @@ Convenience param to add macResizableColumn and dependent directives to template
 Type: `None`  
 Convenience param to add macReorderableColumn and dependent directives to template elements  
 
+
 
diff --git a/docs/directives/tag_autocomplete.md b/docs/directives/tag_autocomplete.md
@@ -3,9 +3,11 @@ Tag Autocomplete
 ===
 A directive for generating tag input with autocomplete support on text input  
 
+
 ### Dependencies
 - mac-autocomplete  
 - mac-menu  
+
 
 ### Parameters
 **mac-tag-autocomplete-url**  
@@ -51,7 +53,7 @@ If autocomplete is enabled or disabled (default false)
 **mac-tag-autocomplete-on-enter**  
 Type: `Expr`  
 When autocomplete is disabled, this function is called on enter, Should return either string, object or boolean. If false, item is not added  
-- `item` - {String} User input  
+        - `item` - {String} User input  
 
 **mac-tag-autocomplete-events**  
 Type: `String`  
@@ -60,8 +62,9 @@ A CSV list of events to attach functions to
 **mac-tag-autocomplete-on-**  
 Type: `Expr`  
 Function to be called when specified event is fired  
-- `event` - {Object} jQuery event  
-- `value` - {String} Value in the input text  
+        - `event` - {Object} jQuery event  
+        - `value` - {String} Value in the input text  
+
 
 **mac-tag-autocomplete-clear-input**  
 Type: `Event`  

diff --git a/docs/directives/time.md b/docs/directives/time.md
@@ -3,6 +3,7 @@ Time
 ===
 A directive for creating a time input field  
 
+
 ### Parameters
 **mac-time-model**  
 Type: `String`  
@@ -21,4 +22,5 @@ Enable or disable time input
 Type: `String`  
 If model is undefined, use this as the starting value (default 12:00 PM)  
 
+
 
diff --git a/docs/directives/tooltip.md b/docs/directives/tooltip.md
@@ -3,6 +3,7 @@ Tooltip
 ===
 Tooltip directive  
 
+
 ### Parameters
 **mac-tooltip**  
 Type: `String`  

diff --git a/docs/filters/list.md b/docs/filters/list.md
@@ -3,6 +3,7 @@ List
 ===
 List filter. Use for converting arrays into a string  
 
+
 ### Parameters
 **list**  
 Type: `Array`  

diff --git a/docs/filters/pluralize.md b/docs/filters/pluralize.md
@@ -3,6 +3,7 @@ Pluralize
 ===
 Pluralizes the given string. It's a simple proxy to the pluralize function on util.  
 
+
 ### Parameters
 **string**  
 Type: `String`  

diff --git a/docs/filters/timestamp.md b/docs/filters/timestamp.md
@@ -4,6 +4,7 @@ Timestamp filter
 Takes in a unix timestamp and turns it into a human-readable relative time string, like "5  
 minutes ago" or "just now".  
 
+
 ### Parameters
 **time**  
 Type: `Unix timestamp`  

diff --git a/docs/filters/underscore.md b/docs/filters/underscore.md
@@ -3,6 +3,7 @@ Underscore string
 ===
 Proxy filter for calling underscore string function  
 
+
 ### Parameters
 **string**  
 Type: `String`  

diff --git a/docs/main.md b/docs/main.md
@@ -4,7 +4,9 @@ angular.element
 Angular comes with jqLite, a tiny, API-compatible subset of jQuery. However, its  
 functionality is very limited and MacGyver extends jqLite to make sure MacGyver  
 components work properly.  
+
 Real jQuery will continue to take precedence over jqLite and all functions MacGyver extends.  
+
 MacGyver adds the following methods:  
 - [height()](http://api.jquery.com/height/) - Does not support set  
 - [width()](http://api.jquery.com/width/) - Does not support set