fix #143, fix some markdown syntax error

lordfriend · lordfriend · commit b04ee168d6e8 · 2016-09-23T23:02:07.000+08:00
diff --git a/docs/dist/css/main.css b/docs/dist/css/main.css
@@ -1,5 +1,5 @@
 /**
- * nya-bootstrap-select v2.1.7
+ * @lordfriend/nya-bootstrap-select v2.1.8
  * Copyright 2014 Nyasoft
  * Licensed under MIT license
  */
diff --git a/docs/dist/css/nya-bs-select.css b/docs/dist/css/nya-bs-select.css
@@ -1,5 +1,5 @@
 /**
- * nya-bootstrap-select v2.1.7
+ * @lordfriend/nya-bootstrap-select v2.1.8
  * Copyright 2014 Nyasoft
  * Licensed under MIT license
  */
diff --git a/docs/dist/js/nya-bs-select.js b/docs/dist/js/nya-bs-select.js
@@ -1,5 +1,5 @@
 /**
- * nya-bootstrap-select v2.1.7
+ * @lordfriend/nya-bootstrap-select v2.1.8
  * Copyright 2014 Nyasoft
  * Licensed under MIT license
  */
diff --git a/docs/src/content/api/nya-bs-config-provider.md b/docs/src/content/api/nya-bs-config-provider.md
@@ -1,4 +1,4 @@
-#nyaBsConfigProvider
+# nyaBsConfigProvider
 
 This provider help the developer configure the default text appearance of nya-bs-select base on user-agent localization. Default implementation of the locale text is `en-us`. 
 
@@ -32,29 +32,41 @@ There are three default text can be configured. Each one has two form, pure text
     <p>**To show a count of selected items. this text string or template should contains a `%d` which will be replaced with number**</p>
   </td>
 </tr>
+<tr>
+  <td>selectAll</td>
+  <td>selectAllTpl</td>
+  <td>selectAll is the action button to select all options by a single click. It is available by setting actions-box="true"</td>
+</tr>
+<tr>
+  <td>deselectAll</td>
+  <td>deselectAllTpl</td>
+  <td>deselectAll is the action button to deselect all options by a single click. It is available by setting actions-box="true"</td>
+</tr>
 </tbody>
 </table>
 
 >NOTE: You shouldn't use any angular directive or expression in template, it will not be parsed. 
 
-###Methods
+### Methods
 
-####`setLocalizedText(localeId, configObj);`
+#### `setLocalizedText(localeId, configObj);`
 
 Register a new locale configuration or override an existing locale configuration.
 
 - `localeId` a string formatted as languageId-countryId, e.g. en-us
-- `configObj` a localized configuration object. should contain one of the three properties.
+- `configObj` a localized configuration object. should contain one of the five properties.
 
 ```javascript
 {
   defaultNoneSelection: 'Nothing selected',
   noSearchResult: 'NO SEARCH RESULT',
-  numberItemSelected: '%d item selected'
+  numberItemSelected: '%d item selected',
+  selectAll: 'Select All',
+  deselectAll: 'Deselect All'
 }
 ```
 
-####`useLocale(localeId);`
+#### `useLocale(localeId);`
 
 Force to use a special locale configuration with given localeId.
 
diff --git a/docs/src/content/api/nya-bs-option.md b/docs/src/content/api/nya-bs-option.md
@@ -1,4 +1,4 @@
-#nyaBsOption
+# nyaBsOption
 
 The main function of this directive is manipulating an option list base on given collection. 
 its expression is very similar as `ng-repeat` but add a little magic to support the special scenario of select component.
@@ -59,17 +59,17 @@ the generated options list will resorted by the result of the expression, and `$
 </tbody>
 </table>
 
-###Special class generated on each element.
+### Special class generated on each element.
 
 When using `group by` expression, the `nyaBsOption` will generate a class `group-item` on each repeated element. 
 To identify the first element of each group. It will also add a class `first-in-group` on the first element of a group.
 Theses class has some special styles to build the group header.
 
-###Directive Info
+### Directive Info
 This directive creates new scope.
 This directive executes at priority level 1000.
 
-###Usage
+### Usage
 
 as attribute:
 ```html
@@ -83,7 +83,7 @@ as attribute:
 </li>
 ```
 
-###Arguments
+### Arguments
 <table class="table table-striped">
 <thead>
  <tr>
diff --git a/docs/src/content/api/nya-bs-select.md b/docs/src/content/api/nya-bs-select.md
@@ -1,8 +1,8 @@
-#nyaBsSelect
+# nyaBsSelect
 
 nyaBsSelect is the main directive of this module. You can consider it as a select directive. It manipulates the the dropdown-toggle content and all user interaction. 
 
-###Usage
+### Usage
 
 as element:
 ```html
@@ -15,7 +15,8 @@ as element:
   [disabled=""]
   [size=""]
   [selected-text-format=""]
-  [title=""]>
+  [title=""]
+  [actions-box=""]>
 ...
 </nya-bs-select>
 ```
@@ -32,7 +33,8 @@ as attribute:
   [disabled=""]
   [size=""]
   [selected-text-format=""]
-  [title=""]>
+  [title=""]
+  [actions-box=""]>
 ...
 </ANY>
 ```
@@ -49,12 +51,13 @@ as class:
   [disabled=""]
   [size=""]
   [selected-text-format=""]
-  [title=""]>
+  [title=""]
+  [actions-box=""]>
 ...
 </ANY>
 ```
 
-###Arguments
+### Arguments
 
 <table class="table table-striped">
 <thead>
@@ -123,5 +126,10 @@ as class:
     <td><small class="label label-primary">string</small></td>
     <td>provide a replacement for default text when nothing is selected.</td>
   </tr>
+  <tr>
+      <td>actions-box(optional)</td>
+      <td><small class="label label-primary">string</small></td>
+      <td>Enable the actions box which contains two action select all and deselect all to do batch operation</td>
+    </tr>
 </tbody>
 </table>
diff --git a/docs/src/content/examples/actions-box.md b/docs/src/content/examples/actions-box.md
@@ -1,4 +1,4 @@
-#Actions Box
+# Actions Box
 
 Actions Box is an additional toggle button inside dropdown menu that give you ability to select/un-select all options with a single click.
 
diff --git a/docs/src/content/examples/alternative-display.md b/docs/src/content/examples/alternative-display.md
@@ -1,4 +1,4 @@
-#Alternative Display
+# Alternative Display
 
 This is a feature borrowed from Bootstrap-select. Add a `title` attribute to each `nya-bs-option`, when an option is selected, the `title` value will be displayed in dropdown-toggle button instead of the content of option.
 
diff --git a/docs/src/content/examples/basic-usage.md b/docs/src/content/examples/basic-usage.md
@@ -1,4 +1,4 @@
-#Basic Usage
+# Basic Usage
 
 nya-bootstrap-select is an directive combination. The main directive is `nya-bs-select`. This directive maintain the value of ng-model and dropdown and toggle button presentation.
 You need to add your options using `<li>` element as children of `nya-bs-select`. You can either add static options or generate options using `nya-bs-option`.
@@ -7,7 +7,7 @@ An option is, in fact, an dropdown list element. So you need to add an anchor el
 
 To make multiple selection. just add `multiple` into `nya-bs-select` element.
 
-###Static Options
+### Static Options
 
 Static Options don't change. you need to add `nya-bs-option` class to each of your `<li>` element to make them as options. Beside, you also need to use `data-value` attribute to specify the value of each option.
 
@@ -44,7 +44,7 @@ $scope.model2 = ['b', 'c'];
 </example>
 
 
-###Dynamic Options
+### Dynamic Options
 
 If you want to generate options from a collection, `nya-bs-option` directive is right for you. Just think it is an alias of `ng-repeat`, with some tweak and magic to support our options and groups.
 
diff --git a/docs/src/content/examples/control-dropdown-menu-size.md b/docs/src/content/examples/control-dropdown-menu-size.md
@@ -1,4 +1,4 @@
-#Control Dropdown Menu Size
+# Control Dropdown Menu Size
 
 This feature is borrowed from Bootstrap-select. It give you ability to control the height of dropdown menu to display certain number of options. To use this feature, add an attribute `data-size` or `size`
 on `nya-bs-select` element. the value of the attribute is the max number of options you want to display. If the number exceed the limit, an scrollbar will be shown on the dropdown menu.
diff --git a/docs/src/content/examples/custom-content.md b/docs/src/content/examples/custom-content.md
@@ -1,4 +1,4 @@
-#Custom Content
+# Custom Content
 
 As you already know, the content of `nya-bs-option` is all depend on your needs. there are only few restrictions on the content.
 
diff --git a/docs/src/content/examples/disable-an-option.md b/docs/src/content/examples/disable-an-option.md
@@ -1,4 +1,4 @@
-#Disable An Option
+# Disable An Option
 
 To disable an option, just add `disabled` class to `nya-bs-option` element. But when your want to disable an entire group of options. you may need to add disabled on every option of the group.
 
diff --git a/docs/src/content/examples/form-control-feature.md b/docs/src/content/examples/form-control-feature.md
@@ -1,10 +1,10 @@
-#Form Control Feature
+# Form Control Feature
 
 Because we don't have an form element to build a form control. Some form features which provided by angular need to be implemented specially.
 
 Currently form control valid and disabled are supported.
 
-###Disable a select
+### Disable a select
 
 To disable a select. Use `disabled="true"` as an attribute on `nya-bs-select` element. the value of this attribute is a data-binding to current scope. So you can use model to control
 an select being disabled or enabled. Note that `ng-disabled` are not supported.
@@ -36,7 +36,7 @@ $scope.options = [
 </file>
 </example>
 
-###ng-required
+### ng-required
 
 `ng-required` and `required` directive are supported. when you add one of these directives. it will check your ng-model and set its `$valid` and `$invalid` property. For details, see [ngModelController](https://docs.angularjs.org/api/ng/type/ngModel.NgModelController)
 When selection is multiple, an empty array or undefined model is invalid. When selection is single, an undefined, empty string, NaN, null model is invalid.
diff --git a/docs/src/content/examples/groups-and-more.md b/docs/src/content/examples/groups-and-more.md
@@ -1,6 +1,6 @@
-#Groups And More
+# Groups And More
 
-###Group features
+### Group features
 The native `<select>` element support `optgroup` tag which can divide options to different groups. So is Bootstrap-select. Although nya-bootstrap-select doesn't use `select` tag anymore, nevertheless, nya-bootstrap-select also supports group features.
 
 The key of this feature is sort the list element by its group property. then using some css to stylize the group header which already implemented in Bootstrap, the `dropdown-header` class.
@@ -74,7 +74,7 @@ $scope.objCollection = {
 </file>
 </example>
 
-###data-value Expression
+### data-value Expression
 
 Sometimes, you may want to use one property instead the object in collection as the result(model) of your selection. The **data-value expression** give an solution for this.
  
@@ -112,7 +112,7 @@ $scope.arrayCollection = [
 </file>
 </example>
 
-###Track By Expression
+### Track By Expression
 
 track by expression is very similar with `ng-repeat` which allow you to identify collection element with some unique property. It is useful when the element may be empty or duplicated. But a select component shouldn't have an duplicated option.
  So In our case, this is not very useful, however, you can use this to improve performance when your array elements are very large.
diff --git a/docs/src/content/examples/layout-and-styles.md b/docs/src/content/examples/layout-and-styles.md
@@ -1,8 +1,8 @@
-#Layout And Styles
+# Layout And Styles
 
 nya-bootstrap-select is a Bootstrap component. Bootstrap 3's grid layout class `col-*` and button style class `btn-*` are fully supported. so is the `form-control` class.
 
-###Layout
+### Layout
 
 Just add `col-*`, `form-control` on `nya-bs-select` element to control your select size.
 
@@ -65,7 +65,7 @@ $scope.options = [
 </file>
 </example>
 
-###Styles
+### Styles
 
 These Button classes are supported: `btn-primary`, `btn-success`, `btn-info`, `btn-warning`, `btn-danger`.
 
@@ -104,7 +104,7 @@ $scope.staticModel2 = 'a';
 </file>
 </example>
 
-###Button Sizes
+### Button Sizes
 
 To get larger or smaller dropdown button, Add `.btn-lg`, `.btn-sm` or `.btn-xs` to `nyBsSelect` Directive
 
diff --git a/docs/src/content/examples/live-search.md b/docs/src/content/examples/live-search.md
@@ -1,4 +1,4 @@
-#Live Search
+# Live Search
 
 This feature is borrowed from Bootstrap-select. It give you ability to search through the options. To use this feature. Add `data-live-search="true"` or `live-search="true"` on the `nya-bs-select` element.
 
diff --git a/docs/src/content/examples/selected-text-format.md b/docs/src/content/examples/selected-text-format.md
@@ -1,4 +1,4 @@
-#Selected Text Format
+# Selected Text Format
 
 This is a feature borrowed from Bootstrap-select. Add an attribute `data-selected-text-format` or `select-texted-format` on `nya-bs-select` element. Then configure its value with the following formats:
 
diff --git a/docs/src/content/examples/show-menu-arrow.md b/docs/src/content/examples/show-menu-arrow.md
@@ -1,4 +1,4 @@
-#Show Menu Arrow
+# Show Menu Arrow
 
 To enable an menu arrow on dropdown menu. just add a class `show-menu-arrow` on `nya-bs-select` element.
 
diff --git a/docs/src/content/examples/tick-icon.md b/docs/src/content/examples/tick-icon.md
@@ -1,4 +1,4 @@
-#Tick Icon
+# Tick Icon
 
 Tick icon can be add via a special class `check-mark` on a `span` element as the last child of the anchor element. The icon can be any Bootstrap glyphon icon or even FontAwesome Icon.
   

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#Actions Box`
	`1`	`+# Actions Box`
`2`	`2`
`3`	`3`	`Actions Box is an additional toggle button inside dropdown menu that give you ability to select/un-select all options with a single click.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#Alternative Display`
	`1`	`+# Alternative Display`
`2`	`2`
`3`	`3`	This is a feature borrowed from Bootstrap-select. Add a `title` attribute to each `nya-bs-option`, when an option is selected, the `title` value will be displayed in dropdown-toggle button instead of the content of option.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#Control Dropdown Menu Size`
	`1`	`+# Control Dropdown Menu Size`
`2`	`2`
`3`	`3`	This feature is borrowed from Bootstrap-select. It give you ability to control the height of dropdown menu to display certain number of options. To use this feature, add an attribute `data-size` or `size`
`4`	`4`	on `nya-bs-select` element. the value of the attribute is the max number of options you want to display. If the number exceed the limit, an scrollbar will be shown on the dropdown menu.