diff --git a/README.md b/README.md index ded295f..f67c1fc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,21 @@ -## MD Composer Extras +# MD Composer Extras -Add some formatting option in your Discourse composer : underline, strikethrough, superscript, subscript, center, align right, justify , float left, float right, and columns. +This Discourse theme component adds formatting options to your Discourse composer. -The CSS for columns and floats is disabled on mobile. By default on mobile columns and float will appear as single column content. The missing CSS can be added in again manually. +* underline +* strikethrough +* superscript +* subscript +* center +* align right +* justify +* float left +* float right +* columns. + +These additions are responsive for desktops and phones, but not for horizon orientation or tablets. These additions have taken into consideration (Slick)[https://github.com/discourse/Discourse-Slick-image-gallery], (Tiles)[https://github.com/discourse/Discourse-Tiles-image-gallery], and (Events)[https://github.com/angusmcleod/discourse-events] when determining what should be placed on the composer bar or in the composer pop out menu. + +There is currently no implemented option for disabling particular buttons, but this can be done through CSS. ## Columns and Floats @@ -12,6 +25,8 @@ Columns have a CSS border to for ease of viewing. A column is broken by placing `[/wrap]` at the end of the first column's content. +The CSS for columns and floats is disabled on mobile. By default on mobile columns and float will appear as single column content. The missing CSS can be added in again manually. + **Column Example** Place the following in your editor to see how columns work. @@ -31,14 +46,16 @@ Test Test ``` -For more informations, see : +## Questions + +For more informations, see: - English : https://meta.discourse.org/t/md-composer-extras/118912 - Français : https://www.mon-discourse.fr/themes/md-composer-extras/ ## Credits -Wrap support by thw26 : https://github.com/thw26 +Wrap support by thw26: https://github.com/thw26