HTML Encode documentation require parameters

doc/app/associate.markdown

@@ -1,4 +1,4 @@
-# app associate <id>
+# app associate &#60;id&#62;
 
 Use this command to associate a project directory with a resin application.
 

doc/app/create.markdown

@@ -1,4 +1,4 @@
-# app create <name>
+# app create &#60;name&#62;
 
 Use this command to create a new resin.io application.
 
@@ -16,6 +16,6 @@ Examples:
 
 ## Options
 
-### --type, -t <type>
+### --type, -t &#60;type&#62;
 
 application type

doc/app/info.markdown

@@ -1,4 +1,4 @@
-# app <id>
+# app &#60;id&#62;
 
 Use this command to show detailed information for a single application.
 

doc/app/remove.markdown

@@ -1,4 +1,4 @@
-# app rm <id>
+# app rm &#60;id&#62;
 
 Use this command to remove a resin.io application.
 

doc/app/restart.markdown

@@ -1,4 +1,4 @@
-# app restart <id>
+# app restart &#60;id&#62;
 
 Use this command to restart all devices that belongs to a certain application.
 

doc/auth/login.markdown

@@ -13,10 +13,10 @@ Examples:
 
 ## Options
 
-### --username, -u <username>
+### --username, -u &#60;username&#62;
 
 user name
 
-### --password, -p <password>
+### --password, -p &#60;password&#62;
 
 user password

doc/auth/signup.markdown

@@ -18,14 +18,14 @@ Examples:
 
 ## Options
 
-### --email, -e <email>
+### --email, -e &#60;email&#62;
 
 user email
 
-### --username, -u <username>
+### --username, -u &#60;username&#62;
 
 user name
 
-### --password, -p <user password>
+### --password, -p &#60;user password&#62;
 
 user password

doc/device/identify.markdown

@@ -1,4 +1,4 @@
-# device identify <uuid>
+# device identify &#60;uuid&#62;
 
 Use this command to identify a device.
 

doc/device/info.markdown

@@ -1,4 +1,4 @@
-# device <id>
+# device &#60;id&#62;
 
 Use this command to show information about a single device.
 

doc/device/init.markdown

@@ -32,18 +32,18 @@ Examples:
 
 ## Options
 
-### --application, --a,app, --a,app <application>
+### --application, --a,app, --a,app &#60;application&#62;
 
 application id
 
-### --network, -n <network>
+### --network, -n &#60;network&#62;
 
 network type
 
-### --ssid, -s <ssid>
+### --ssid, -s &#60;ssid&#62;
 
 wifi ssid, if network is wifi
 
-### --key, -k <key>
+### --key, -k &#60;key&#62;
 
 wifi key, if network is wifi

doc/device/list.markdown

@@ -8,6 +8,6 @@ Examples:
 
 ## Options
 
-### --application, --a,app, --a,app <application>
+### --application, --a,app, --a,app &#60;application&#62;
 
 application id

doc/device/remove.markdown

@@ -1,4 +1,4 @@
-# device rm <id>
+# device rm &#60;id&#62;
 
 Use this command to remove a device from resin.io.
 

doc/device/rename.markdown

@@ -1,4 +1,4 @@
-# device rename <id> [name]
+# device rename &#60;id&#62; [name]
 
 Use this command to rename a device.
 

doc/environment-variables/add.markdown

@@ -1,4 +1,4 @@
-# env add <key> [value]
+# env add &#60;key&#62; [value]
 
 Use this command to add an enviroment variable to an application.
 
@@ -17,6 +17,6 @@ Examples:
 
 ## Options
 
-### --application, --a,app, --a,app <application>
+### --application, --a,app, --a,app &#60;application&#62;
 
 application id

doc/environment-variables/list.markdown

@@ -14,7 +14,7 @@ Example:
 
 ## Options
 
-### --application, --a,app, --a,app <application>
+### --application, --a,app, --a,app &#60;application&#62;
 
 application id
 

doc/environment-variables/remove.markdown

@@ -1,4 +1,4 @@
-# env rm <id>
+# env rm &#60;id&#62;
 
 Use this command to remove an environment variable from an application.
 

doc/environment-variables/rename.markdown

@@ -1,4 +1,4 @@
-# env rename <id> <value>
+# env rename &#60;id&#62; &#60;value&#62;
 
 Use this command to rename an enviroment variable from an application.
 

doc/examples/clone.markdown

@@ -1,4 +1,4 @@
-# example clone <id>
+# example clone &#60;id&#62;
 
 Use this command to clone an example application to the current directory
 

doc/examples/info.markdown

@@ -1,4 +1,4 @@
-# example <id>
+# example &#60;id&#62;
 
 Use this command to show information of a single example application
 

doc/keys/add.markdown

@@ -1,4 +1,4 @@
-# key add <name> [path]
+# key add &#60;name&#62; [path]
 
 Use this command to associate a new SSH key with your account.
 

doc/keys/info.markdown

@@ -1,4 +1,4 @@
-# key <id>
+# key &#60;id&#62;
 
 Use this command to show information about a single SSH key.
 

doc/keys/remove.markdown

@@ -1,4 +1,4 @@
-# key rm <id>
+# key rm &#60;id&#62;
 
 Use this command to remove a SSH key from resin.io.
 

doc/notes/set.markdown

@@ -1,4 +1,4 @@
-# note <|note>
+# note &#60;|note&#62;
 
 Use this command to set or update a device note.
 
@@ -13,6 +13,6 @@ Examples:
 
 ## Options
 
-### --device, --d,dev, --d,dev <device>
+### --device, --d,dev, --d,dev &#60;device&#62;
 
 device id

doc/os/download.markdown

@@ -1,4 +1,4 @@
-# os download <id>
+# os download &#60;id&#62;
 
 Use this command to download the device OS configured to a specific network.
 
@@ -22,18 +22,18 @@ Examples:
 
 ## Options
 
-### --network, -n <network>
+### --network, -n &#60;network&#62;
 
 network type
 
-### --ssid, -s <ssid>
+### --ssid, -s &#60;ssid&#62;
 
 wifi ssid, if network is wifi
 
-### --key, -k <key>
+### --key, -k &#60;key&#62;
 
 wifi key, if network is wifi
 
-### --output, -o <output>
+### --output, -o &#60;output&#62;
 
 output file

doc/os/install.markdown

@@ -1,4 +1,4 @@
-# os install <image> [device]
+# os install &#60;image&#62; [device]
 
 Use this command to write an operating system image to a device.
 

doc/plugin/install.markdown

@@ -1,4 +1,4 @@
-# plugin install <name>
+# plugin install &#60;name&#62;
 
 Use this command to install a resin plugin
 

doc/plugin/remove.markdown

@@ -1,4 +1,4 @@
-# plugin rm <name>
+# plugin rm &#60;name&#62;
 
 Use this command to remove a resin.io plugin.
 

doc/plugin/update.markdown

@@ -1,4 +1,4 @@
-# plugin update <name>
+# plugin update &#60;name&#62;
 
 Use this command to update a resin plugin
 

extras/capitano-doc/markdown.coffee

@@ -1,4 +1,5 @@
 _ = require('lodash')
+ent = require('ent')
 utils = require('./utils')
 
 exports.option = (option) ->
@@ -6,7 +7,7 @@ exports.option = (option) ->
 
 exports.command = (command) ->
 	result = """
-		# #{command.signature}
+		# #{ent.encode(command.signature)}
 
 		#{command.help}\n
 	"""

extras/capitano-doc/utils.coffee

@@ -1,4 +1,5 @@
 _ = require('lodash')
+ent = require('ent')
 
 exports.getOptionPrefix = (signature) ->
 	if signature.length > 1
@@ -22,4 +23,4 @@ exports.parseSignature = (option) ->
 	if option.parameter?
 		result += " <#{option.parameter}>"
 
-	return result
+	return ent.encode(result)

package.json

@@ -33,6 +33,7 @@
   },
   "devDependencies": {
     "chai": "~1.9.2",
+    "ent": "^2.2.0",
     "gulp": "~3.8.9",
     "gulp-coffee": "^2.2.0",
     "gulp-coffeelint": "~0.4.0",