Skip to content

Commit 14810a1

Browse files
author
Tomas Kirda
authored
Merge pull request #596 from ErikSchierboom/patch-1
Update README to use correct markdown for headers
2 parents 44ad256 + 5c33d71 commit 14810a1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

readme.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Devbridge Group accelerates software to market for enterprise clients through de
22

33
[www.devbridge.com](http://www.devbridge.com/)
44

5-
#Ajax Autocomplete for jQuery
5+
# Ajax Autocomplete for jQuery
66

77
Ajax Autocomplete for jQuery allows you to easily create
88
autocomplete/autosuggest boxes for text input fields.
@@ -11,13 +11,13 @@ Has no dependencies other than jQuery.
1111

1212
The standard jquery.autocomplete.js file is around 13KB when minified.
1313

14-
##API
14+
## API
1515

1616
* `$(selector).autocomplete(options);`
1717
* Sets up autocomplete for input field(s).
1818
* `options`: An object literal which defines the settings to use for the autocomplete plugin. Available option settings listed below.
1919

20-
###Ajax Settings
20+
### Ajax Settings
2121
* `serviceUrl`: Server side URL or callback function that returns serviceUrl string. Optional if local lookup data is provided.
2222
* `type`: Ajax request type to get suggestions. Default: `GET`.
2323
* `dataType`: type of data returned from server. Either `text` (default), `json` or `jsonp`, which will cause the autocomplete to use jsonp. You may return a json object in your callback when using jsonp.
@@ -26,7 +26,7 @@ The standard jquery.autocomplete.js file is around 13KB when minified.
2626
* `deferRequestBy`: Number of miliseconds to defer Ajax request. Default: `0`.
2727
* `ajaxSettings`: Any additional [Ajax Settings](http://api.jquery.com/jquery.ajax/#jQuery-ajax-settings) that configure the jQuery Ajax request.
2828

29-
###Configuration Settings
29+
### Configuration Settings
3030
* `noCache`: Boolean value indicating whether to cache suggestion results. Default `false`.
3131
* `delimiter`: String or RegExp, that splits input value and takes last part to as query for suggestions.
3232
Useful when for example you need to fill list of comma separated values.
@@ -46,7 +46,7 @@ The standard jquery.autocomplete.js file is around 13KB when minified.
4646
* `autoSelectFirst`: if set to `true`, first item will be selected when showing suggestions. Default value `false`.
4747
* `onHide`: `function (container) {}` called before container will be hidden
4848

49-
###Presentation Settings
49+
### Presentation Settings
5050
* `beforeRender`: `function (container, suggestions) {}` called before displaying the suggestions. You may manipulate suggestions DOM before it is displayed.
5151
* `formatResult`: `function (suggestion, currentValue) {}` custom function to
5252
format suggestion entry inside suggestions container, optional.
@@ -98,7 +98,7 @@ $('#autocomplete').autocomplete().disable();
9898
$('#autocomplete').autocomplete().setOptions(options);
9999
```
100100

101-
##Usage
101+
## Usage
102102

103103
Html:
104104

@@ -157,7 +157,7 @@ $('#autocomplete').autocomplete({
157157
});
158158
```
159159

160-
##Styling
160+
## Styling
161161

162162
Generated HTML markup for suggestions is displayed below. You may style it any way you'd like.
163163

@@ -182,7 +182,7 @@ Style sample:
182182
```
183183

184184

185-
##Response Format
185+
## Response Format
186186

187187
Response from the server must be JSON formatted following JavaScript object:
188188

@@ -240,7 +240,7 @@ Specify `groupBy` option of you data property if you wish results to be displaye
240240

241241
Results will be formatted into two groups **NHL** and **NBA**.
242242

243-
##Known Issues
243+
## Known Issues
244244

245245
If you use it with jQuery UI library it also has plugin named `autocomplete`. In this case you can use plugin alias `devbridgeAutocomplete`:
246246

@@ -256,14 +256,14 @@ It seems that for mobile Safari click events are only triggered if the CSS of th
256256

257257
See issue #542
258258

259-
##License
259+
## License
260260

261261
Ajax Autocomplete for jQuery is freely distributable under the
262262
terms of an MIT-style [license](https://github.com/devbridge/jQuery-Autocomplete/blob/master/dist/license.txt).
263263

264264
Copyright notice and permission notice shall be included in all
265265
copies or substantial portions of the Software.
266266

267-
##Authors
267+
## Authors
268268

269269
Tomas Kirda / [@tkirda](https://twitter.com/tkirda)

0 commit comments

Comments
 (0)