Tweak the documentation for better github rendering

Author: pyrech

README.md

@@ -16,8 +16,8 @@ It works on Linux, Windows or MacOS.
 Requires PHP >= 7.4 (support for PHP 5 was available in version 1.x, for PHP 7.0
 and 7.1 in version < 2.1.0, for PHP 7.2 and 7.3 in version < 2.4.0).
 
->**Note**: This library can not be used in a web context (FPM or equivalent).
-Use it in your CLI scripts or in a [CRON](doc/04-cron-usage.md)
+> **Note**
+> This library can not be used in a web context (FPM or equivalent). Use it in your CLI scripts or in a [CRON](doc/04-cron-usage.md)
 
 ## Installation
 

doc/01-basic-usage.md

@@ -16,8 +16,9 @@ The factory use the notifier's priority to determine the best notifier to use.
 For example some notifier has a low priority because they don't support some
 notification options. The best notifier will then be returned.
 
-> **Note**: The factory now returns a NullNotifier instead of null when no
-> notifier is available. You then no longer have to check for null value.
+> **Note**
+> The factory now returns a NullNotifier instead of null when no notifier is
+> available. You then no longer have to check for null value.
 
 If you really need to ensure a Notifier is available, you can use the
 `createOrThrowException` method. It will return the best notifier available or

doc/02-notification.md

@@ -3,8 +3,9 @@
 `Notification` is the main model of JoliNotif. It contains all the options
 that should be applied - if possible - by the notifier.
 
-> **Note**: Notifiers are designed to handle the options they support and
-> discard not supported ones gracefully without throwing any exception.
+> **Note**
+> Notifiers are designed to handle the options they support and discard not
+> supported ones gracefully without throwing any exception.
 
 Currently, only three options are supported but new ones could be added later.
 Each option can be set via a setter on the `Notification` class.
@@ -13,8 +14,9 @@ Each option can be set via a setter on the `Notification` class.
 
 The body is the main message of the notification that you want to display.
 
-> **Important**: This is the only required option. Notifiers will throw an
-> `InvalidNotificationException` if the body is empty or null.
+> **Note**
+> This is the only required option. Notifiers will throw an`InvalidNotificationException`
+> if the body is empty or null.
 
 ## Title
 
@@ -30,9 +32,10 @@ An icon can also be displayed inside the notification. You will need to set an
 $notification->setIcon(__DIR__.'/Resources/icons/success.png');
 ```
 
-> **Note**: If you use JoliNotif from a phar and add a notification icon, we
-> will take care to extract this icon in your system temp directory to make it
-> accessible from command line executable.
+> **Note**
+> If you use JoliNotif from a phar and add a notification icon, we will take
+> care to extract this icon in your system temp directory to make it accessible
+> from command line executable.
 
 Not all notifiers support icon but again, you can safely add an icon to your
 notification since the notifier will discard it if not supported.

doc/04-cron-usage.md

@@ -13,8 +13,9 @@ cronjob:
 * * * * * XDG_RUNTIME_DIR=/run/user/$(id -u) php /path/to/your/script
 ```
 
-> **Note**: On some system, you may also/instead need to set DISPLAY env var
-> and/or to run `xhost +local:`. For more information, please have a look at
+> **Note**
+> On some system, you may also/instead need to set DISPLAY env var and/or to
+> run `xhost +local:`. For more information, please have a look at
 > [https://help.ubuntu.com/community/CronHowto#GUI_Applications](https://help.ubuntu.com/community/CronHowto#GUI_Applications)
 
 ## Next readings

doc/05-cli-usage.md

@@ -8,7 +8,11 @@ Install package globally:
 $ composer global require jolicode/jolinotif
 ```
 
-**Note!** Make sure to place the `~/.composer/vendor/bin` directory (or the equivalent directory for your OS) in your PATH so the transfer executable can be located by your system. Simply add this directory to your PATH in your `~/.bashrc` (or `~/.bash_profile`) like this:
+> **Note**
+> Make sure to place the `~/.composer/vendor/bin` directory (or the equivalent
+> directory for your OS) in your PATH so the transfer executable can be located
+> by your system. Simply add this directory to your PATH in your `~/.bashrc`
+> (or `~/.bash_profile`) like this:
 
 ```
 $ echo "export PATH=~/.composer/vendor/bin:$PATH" >> ~/.bashrc