Skip to content

Commit 9dfec70

Browse files
authored
Merge pull request #94 from bryant1410/master
Fix broken headings in Markdown files
2 parents 2152462 + 9d20574 commit 9dfec70

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,27 @@ Screen shots
2525

2626
Here are some screen shots since i didn't have time to put a demo yet:
2727

28-
###Simple Image widget###
28+
### Simple Image widget ###
2929

3030
![alt tag](http://canomur.com/comur-image/images/image_widget_ss1.png)
3131

32-
###Gallery widget###
32+
### Gallery widget ###
3333

3434
![alt tag](http://canomur.com/comur-image/images/gallery_widget_ss1.png)
3535

36-
###Upload image screen###
36+
### Upload image screen ###
3737

3838
![alt tag](http://canomur.com/comur-image/images/upload_image_ss1.png)
3939

40-
###Select image from library screen###
40+
### Select image from library screen ###
4141

4242
![alt tag](http://canomur.com/comur-image/images/select_image_ss1.png)
4343

44-
###Crop image screen###
44+
### Crop image screen ###
4545

4646
![alt tag](http://canomur.com/comur-image/images/crop_image_ss1.png)
4747

48-
###Change gallery image order screen###
48+
### Change gallery image order screen ###
4949

5050
![alt tag](http://canomur.com/comur-image/images/order_image_ss1.png)
5151

@@ -129,49 +129,49 @@ Configuration
129129
gallery_thumb_size: 150
130130
gallery_dir: 'gallery'
131131
132-
###cropped_image_dir###
132+
### cropped_image_dir ###
133133
134134
It's used to determine relative directory name to put cropped images (see above).
135135
136136
**Default value:** 'cropped'
137137
138-
###thumbs_dir###
138+
### thumbs_dir ###
139139
140140
It's used to determine relative directory name to put thumbnails (see above).
141141
142142
**Default value:** 'thumbnails'
143143
144-
###media_lib_thumb_size###
144+
### media_lib_thumb_size ###
145145
146146
It's used to determine thumbnails size in pixels (squares) used in media library.
147147
148148
**Default value:** 150
149149
150-
###upload_dir###
150+
### upload_dir ###
151151
152152
Dirname of your public directory. It's used to check thumb existence in thumb twig helper.
153153
154154
**Default value:** 'web'
155155
156-
###translation_domain###
156+
### translation_domain ###
157157
158158
Domain name for translations. For instance two languages are provided (en & fr). To override the domain name, change this parameter to whatever you want.
159159
160160
**Default value:** 'ComurImageBundle'
161161
162-
###gallery_thumb_size###
162+
### gallery_thumb_size ###
163163
164164
That's the image size in pixels that you want to show in gallery widget. Gallery widget will automaticaly create square thums having this size and show them in the gallery widget.
165165
166166
**Default value:** 150
167167
168-
###gallery_dir###
168+
### gallery_dir ###
169169
170170
That's the gallery directory name. The widget will store all gallery images in a specific directory inside the root directory that you will give when you will add the widget to your forms.
171171
172172
**For eg.** if you put 'uploads/images' as webDir when you add the widget, gallery images will be stored in 'uploads/images/*[gallery_dir]*'. This is added to make gallery use easier so you don't have to add new functions to your entities to get gallery dirs.
173173
174-
#Usage#
174+
# Usage #
175175
176176
177177
There are two widgets provided with this bundle. They both have exacly same config parameters.
@@ -318,15 +318,15 @@ That's all ! This will create a widget like on the following image when you will
318318
319319
Gallery images will be stored in uploadUrl / gallery_dir (default is gallery). Cropped images will be stored in uploadUrl / gallery_dir / cropped_dir (same as image widget) and thumbs in uploadUrl / gallery_dir / cropped_dir / thumb_dir with specified width. So if you pu
320320
321-
##uploadConfig##
321+
## uploadConfig ##
322322
323-
###uploadRoute (optional)###
323+
### uploadRoute (optional) ###
324324
325325
Route called to send uploaded file. It's recommended to not change this parameter except if you know exactly what you do.
326326
327327
**Default value:** comur_api_upload
328328
329-
###uploadUrl (required)###
329+
### uploadUrl (required) ###
330330
331331
Absolute url to directory where put uploaded image. I recommend you to create a function in your entity and call it like it's showen in the example:
332332
@@ -352,80 +352,80 @@ Absolute url to directory where put uploaded image. I recommend you to create a
352352
}
353353
354354
355-
###webDir (required)###
355+
### webDir (required) ###
356356
357357
Url used to show your image in templates, must be relative url. If you created related functions as explained in uploadUrl section, then you can user getWebPath() function for webDir parameter.
358358
359-
###fileExt (optional)###
359+
### fileExt (optional) ###
360360
361361
Permitted image extensions.
362362
363363
**Default value:** '*.jpg;*.gif;*.png;*.jpeg'
364364
365-
###libraryDir (optional)###
365+
### libraryDir (optional) ###
366366
367367
Directory to look into for images to show in image library.
368368
369369
**Default value:** uploadUrl
370370
371-
###libraryRoute (optional)###
371+
### libraryRoute (optional) ###
372372
373373
Route called to get images to show in library. I recommend you to not change this parameter if you don't know exactly what it does.
374374
375375
**Default value:** comur_api_image_library
376376
377-
###showLibrary (optional)###
377+
### showLibrary (optional) ###
378378
379379
Set this to false if you don't want the user see existing images in libraryDir.
380380
381381
**Default value:** true
382382
383-
###saveOriginal (optional)###
383+
### saveOriginal (optional) ###
384384
385385
Use this parameter if you want to save original file's path (for eg. to show big image in a lightbox). You have to put property name of your entity and the bundle will use it to save original file path in it.
386386
387387
**Attention:** This parameter is disabled for gallery for instance. It will be implemented soon.
388388
389389
**Default value:** false
390390
391-
###generateFilename (optional)###
391+
### generateFilename (optional) ###
392392
393393
This parameter is used to generate an uniq file name. Setted to false, it will keep the original filename.
394394
395395
**Default value:** true
396396
397397
398-
##cropConfig##
398+
## cropConfig ##
399399
400-
###minWidth (optional)###
400+
### minWidth (optional) ###
401401
402402
Minimum with of desired image.
403403
404404
**Default value:** 1
405405
406-
###minHeight (optional)###
406+
### minHeight (optional) ###
407407
408408
Minimum height of desired image.
409409
410410
**Default value:** 1
411-
###aspectRatio (optional)###
411+
### aspectRatio (optional) ###
412412
413413
True to aspect ratio of crop screen.
414414
415415
**Default value:** true
416416
417-
###cropRoute (optional)###
417+
### cropRoute (optional) ###
418418
419419
Route to crop action. I recommend you to not change this parameter if you don't know exactly what it does.
420420
421421
**Default value:** comur_api_crop
422422
423423
424-
###forceResize (optional)###
424+
### forceResize (optional) ###
425425
426426
If true, system will resize image to fit minWidth and minHeight.
427427
428-
###thumbs (optional)###
428+
### thumbs (optional) ###
429429
430430
Array of thums to create automaticly. System will resize images to fit maxWidth and maxHeight. It will put them in "uploadDir/cropped_images_dir/thumbs_dir/widthxheight-originalfilename.extension" so you can use included Thumb Twig extension to get them, ex:
431431
@@ -437,7 +437,7 @@ Array of thums to create automaticly. System will resize images to fit maxWidth
437437
438438
**New in 0.2.2:** You can use 'useAsFieldImage' option to use this thumb as image field's preview (in your form you will see this thumb instead of original cropped image). Usefull when you have big cropped images.
439439
440-
#TODO LIST#
440+
# TODO LIST #
441441
442442
* Create tests
443443
* Add more comments in the code

0 commit comments

Comments
 (0)