improve output in example READMEs

Author: DannyBen

Runfile

@@ -87,15 +87,16 @@ class Example
   end
 
   def test_output
-    result = "```shell\n"
+    result = ''
     test_commands.each do |command|
-      result += "$ #{command}\n\n"
+      result += "### `$ #{command}`\n\n"
+      result += "```shell\n"
       Dir.chdir dir do
         result += `#{command} 2>&1`
         result += "\n\n"
       end
+      result += "```\n\n"
     end
-    result += "```\n\n"
     result
   end
 

examples/catch-all-advanced/README.md

@@ -60,9 +60,9 @@ commands:
 
 ## Generated script output
 
-```shell
-$ ./cli
+### `$ ./cli`
 
+```shell
 cli - Sample application
 
 Usage:
@@ -76,8 +76,11 @@ Commands:
 
 
 
-$ ./cli download -h
+```
+
+### `$ ./cli download -h`
 
+```shell
 cli download - Download a file
 
 Shortcut: d
@@ -109,17 +112,23 @@ Examples:
 
 
 
-$ ./cli download source
+```
+
+### `$ ./cli download source`
 
+```shell
 # this file is located in 'src/download_command.sh'
 # code for 'cli download' goes here
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
 - ${args[source]} = source
 
 
-$ ./cli download source target
+```
+
+### `$ ./cli download source target`
 
+```shell
 # this file is located in 'src/download_command.sh'
 # code for 'cli download' goes here
 # you can edit it freely and regenerate (it will not be overwritten)
@@ -128,8 +137,11 @@ args:
 - ${args[target]} = target
 
 
-$ ./cli download source target and --additional stuff
+```
+
+### `$ ./cli download source target and --additional stuff`
 
+```shell
 # this file is located in 'src/download_command.sh'
 # code for 'cli download' goes here
 # you can edit it freely and regenerate (it will not be overwritten)

examples/catch-all/README.md

@@ -23,15 +23,18 @@ args:
 
 ## Generated script output
 
-```shell
-$ ./download
+### `$ ./download`
 
+```shell
 missing required argument: MESSAGE
 usage: download MESSAGE [...]
 
 
-$ ./download -h
+```
+
+### `$ ./download -h`
 
+```shell
 download - Catch All Example
 
 Usage:
@@ -52,16 +55,22 @@ Arguments:
 
 
 
-$ ./download something
+```
 
+### `$ ./download something`
+
+```shell
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
 - ${args[message]} = something
 
 
-$ ./download something with --additional args
+```
 
+### `$ ./download something with --additional args`
+
+```shell
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:

examples/colors/README.md

@@ -29,9 +29,9 @@ args:
 
 ## Generated script output
 
-```shell
-$ ./colorly
+### `$ ./colorly`
 
+```shell
 Message Recevied:
 
   => hello colors

examples/command-default/README.md

@@ -38,9 +38,9 @@ commands:
 
 ## Generated script output
 
-```shell
-$ ./ftp
+### `$ ./ftp`
 
+```shell
 ftp - Sample application that uses the default command option
 
 Usage:
@@ -54,8 +54,11 @@ Commands:
 
 
 
-$ ./ftp -h
+```
+
+### `$ ./ftp -h`
 
+```shell
 ftp - Sample application that uses the default command option
 
 Usage:
@@ -76,26 +79,35 @@ Options:
 
 
 
-$ ./ftp download something
+```
+
+### `$ ./ftp download something`
 
+```shell
 # this file is located in 'src/download_command.sh'
 # code for 'ftp download' goes here
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
 - ${args[source]} = something
 
 
-$ ./ftp upload something
+```
+
+### `$ ./ftp upload something`
 
+```shell
 # this file is located in 'src/upload_command.sh'
 # code for 'ftp upload' goes here
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
 - ${args[source]} = something
 
 
-$ ./ftp something
+```
+
+### `$ ./ftp something`
 
+```shell
 # this file is located in 'src/upload_command.sh'
 # code for 'ftp upload' goes here
 # you can edit it freely and regenerate (it will not be overwritten)

examples/command-groups/README.md

@@ -46,9 +46,9 @@ commands:
 
 ## Generated script output
 
-```shell
-$ ./ftp
+### `$ ./ftp`
 
+```shell
 ftp - Sample application with command grouping
 
 Usage:
@@ -66,8 +66,11 @@ Login Commands:
 
 
 
-$ ./ftp -h
+```
+
+### `$ ./ftp -h`
 
+```shell
 ftp - Sample application with command grouping
 
 Usage:
@@ -92,8 +95,11 @@ Options:
 
 
 
-$ ./ftp login
+```
+
+### `$ ./ftp login`
 
+```shell
 # this file is located in 'src/login_command.sh'
 # code for 'ftp login' goes here
 # you can edit it freely and regenerate (it will not be overwritten)

examples/commands-nested/README.md

@@ -63,9 +63,9 @@ commands:
 
 ## Generated script output
 
-```shell
-$ ./cli
+### `$ ./cli`
 
+```shell
 cli - Sample application with nested commands
 
 Usage:
@@ -79,8 +79,11 @@ Commands:
 
 
 
-$ ./cli -h
+```
+
+### `$ ./cli -h`
 
+```shell
 cli - Sample application with nested commands
 
 Usage:
@@ -101,8 +104,11 @@ Options:
 
 
 
-$ ./cli dir
+```
+
+### `$ ./cli dir`
 
+```shell
 cli dir - Directory commands
 
 Shortcut: d
@@ -117,8 +123,11 @@ Commands:
 
 
 
-$ ./cli file
+```
+
+### `$ ./cli file`
 
+```shell
 cli file - File commands
 
 Shortcut: f
@@ -133,8 +142,11 @@ Commands:
 
 
 
-$ ./cli dir -h
+```
+
+### `$ ./cli dir -h`
 
+```shell
 cli dir - Directory commands
 
 Shortcut: d
@@ -153,8 +165,11 @@ Options:
 
 
 
-$ ./cli file -h
+```
+
+### `$ ./cli file -h`
 
+```shell
 cli file - File commands
 
 Shortcut: f
@@ -173,14 +188,20 @@ Options:
 
 
 
-$ ./cli dir list
+```
+
+### `$ ./cli dir list`
 
+```shell
 missing required argument: PATH
 usage: cli dir list PATH
 
 
-$ ./cli dir list -h
+```
+
+### `$ ./cli dir list -h`
 
+```shell
 cli dir list - Show files in the directory
 
 Usage:
@@ -197,14 +218,20 @@ Arguments:
 
 
 
-$ ./cli file edit
+```
+
+### `$ ./cli file edit`
 
+```shell
 missing required argument: PATH
 usage: cli file edit PATH
 
 
-$ ./cli file edit -h
+```
+
+### `$ ./cli file edit -h`
 
+```shell
 cli file edit - Edit the file
 
 Usage:
@@ -221,8 +248,11 @@ Arguments:
 
 
 
-$ ./cli file edit filename
+```
+
+### `$ ./cli file edit filename`
 
+```shell
 # this file is located in 'src/file_edit_command.sh'
 # code for 'cli file edit' goes here
 # you can edit it freely and regenerate (it will not be overwritten)