docs: add kcl doc tool escape html flag docs

Signed-off-by: peefy <[email protected]>

Author: Peefy

cmd/kcl/commands/doc.go

@@ -20,6 +20,9 @@ const (
 	docGenExample = `  # Generate Markdown document for current package
   kcl doc generate
 
+  # Generate Markdown document for current package and escape the HTML symbols | to \|, \n to <br>, etc.
+  kcl doc generate --escape-html
+
   # Generate Html document for current package
   kcl doc generate --format html