Merge pull request #430 from DannyBen/update/render-templates

Update mandoc and markdown templates and examples

Author: DannyBen

examples/README.md

@@ -69,6 +69,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 ## Documentation generation
 
 - [render-mandoc](render-mandoc#readme) - auto-generate man pages for your script
+- [render-markdown](render-markdown#readme) - auto-generate markdown documentation for your script
 
 ## Other examples
 

examples/catch-all-advanced/README.md

@@ -15,7 +15,7 @@ $ bashly generate
 
 ## `bashly.yml`
 
-```yaml
+````yaml
 name: cli
 help: Sample application
 version: 0.1.0
@@ -58,15 +58,15 @@ commands:
     label: Files
     help: Files to upload
     required: true
-```
+````
 
 
 
-## Generated script output
+## Output
 
 ### `$ ./cli`
 
-```shell
+````shell
 cli - Sample application
 
 Usage:
@@ -80,11 +80,11 @@ Commands:
 
 
 
-```
+````
 
 ### `$ ./cli download -h`
 
-```shell
+````shell
 cli download - Download a file
 
 Alias: d
@@ -116,23 +116,23 @@ Examples:
 
 
 
-```
+````
 
 ### `$ ./cli download source`
 
-```shell
+````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`
 
-```shell
+````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)
@@ -141,11 +141,11 @@ args:
 - ${args[target]} = target
 
 
-```
+````
 
 ### `$ ./cli download source target and --additional stuff`
 
-```shell
+````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)
@@ -160,11 +160,11 @@ other_args:
 - ${other_args[2]} = stuff
 
 
-```
+````
 
 ### `$ ./cli upload -h`
 
-```shell
+````shell
 cli upload - Upload a file
 
 Alias: u
@@ -183,20 +183,20 @@ Arguments:
 
 
 
-```
+````
 
 ### `$ ./cli upload`
 
-```shell
+````shell
 missing required argument: FILES...
 usage: cli upload FILES...
 
 
-```
+````
 
 ### `$ ./cli upload file1 "file 2" file3`
 
-```shell
+````shell
 # this file is located in 'src/upload_command.sh'
 # code for 'cli upload' goes here
 # you can edit it freely and regenerate (it will not be overwritten)
@@ -209,7 +209,7 @@ other_args:
 - ${other_args[2]} = file3
 
 
-```
+````
 
 
 

examples/catch-all-stdin/README.md

@@ -17,7 +17,7 @@ $ bashly generate
 
 ## `bashly.yml`
 
-```yaml
+````yaml
 name: cli
 help: Sample application
 version: 0.1.0
@@ -39,11 +39,11 @@ examples:
 - cli --format csv file1 file2
 - cat file1 | cli --format csv
 - cat file* | cli - --format csv
-```
+````
 
 ## `src/root_command.sh`
 
-```bash
+````bash
 inspect_args
 
 # Read contents of the provided file(s)
@@ -63,14 +63,14 @@ echo "collected file contents:"
 echo "$content"
 echo
 
-```
+````
 
 
-## Generated script output
+## Output
 
 ### `$ ./cli -h`
 
-```shell
+````shell
 cli - Sample application
 
 Usage:
@@ -102,11 +102,11 @@ Examples:
 
 
 
-```
+````
 
 ### `$ ./cli file1 file2 --format csv`
 
-```shell
+````shell
 args:
 - ${args[--format]} = csv
 
@@ -122,11 +122,11 @@ file2 content
 
 
 
-```
+````
 
 ### `$ ./cli -f=csv file1 file2`
 
-```shell
+````shell
 args:
 - ${args[--format]} = csv
 
@@ -142,11 +142,11 @@ file2 content
 
 
 
-```
+````
 
 ### `$ cat file1 | ./cli --format csv`
 
-```shell
+````shell
 args:
 - ${args[--format]} = csv
 
@@ -155,11 +155,11 @@ file1 content
 
 
 
-```
+````
 
 ### `$ cat file* | ./cli -`
 
-```shell
+````shell
 args:
 - ${args[--format]} = json
 
@@ -174,7 +174,7 @@ file2 content
 
 
 
-```
+````
 
 
 

examples/catch-all/README.md

@@ -15,7 +15,7 @@ $ bashly generate
 
 ## `bashly.yml`
 
-```yaml
+````yaml
 name: download
 help: Catch All Example
 version: 0.1.0
@@ -31,24 +31,24 @@ args:
 flags:
 - long: --debug
   short: -d
-```
+````
 
 
 
-## Generated script output
+## Output
 
 ### `$ ./download`
 
-```shell
+````shell
 missing required argument: MESSAGE
 usage: download MESSAGE [OPTIONS] [...]
 
 
-```
+````
 
 ### `$ ./download -h`
 
-```shell
+````shell
 download - Catch All Example
 
 Usage:
@@ -72,22 +72,22 @@ Arguments:
 
 
 
-```
+````
 
 ### `$ ./download something`
 
-```shell
+````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`
 
-```shell
+````shell
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
@@ -100,11 +100,11 @@ other_args:
 - ${other_args[2]} = args
 
 
-```
+````
 
 ### `$ ./download something --debug -- also pass --debug to catch_all`
 
-```shell
+````shell
 # this file is located in 'src/root_command.sh'
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
@@ -120,7 +120,7 @@ other_args:
 - ${other_args[4]} = catch_all
 
 
-```
+````