escapes single element content

bit-docs · Jun 4, 2018 · 911d9f8 · 911d9f8
1 parent 2344173
commit 911d9f8
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 6 deletions.
diff --git a/build/build_test.js b/build/build_test.js
@@ -182,7 +182,7 @@ describe("documentjs/lib/generators/html/build", function(){
 			var renderer = results[0];
 			var result = renderer(docObject);
 
-			assert.equal(result, "<html><p>This is <a href=\"something.html\" title=\"something\"><something/></a></p>\n\n</html>");
+			assert.equal(result, "<html><p>This is <a href=\"something.html\" title=\"something\">&lt;something/&gt;</a></p>\n\n</html>");
 		});
 	});
 });
diff --git a/build/make_default_helpers.js b/build/make_default_helpers.js
@@ -7,6 +7,18 @@ var striptags = require('striptags');
 var DocMapInfo = require("../doc-map-info");
 var unescapeHTML = require("unescape-html");
 
+
+function escapeOnlySingleElements(text) {
+	//This could be an alternate way of detecting if markdown escaped
+	//var html = stmd_to_html("<p>"+text+"</p>\n");
+	//if(html === "<p>"+text+"</p>\n") { }
+	if(/^<\w+\/?>$/.test(text)) {
+		return escape(text);
+	} else {
+		return text;
+	}
+}
+
 // Helper helpers
 
 var sortChildren = function(child1, child2) {
@@ -200,11 +212,11 @@ module.exports = function(docMap, config, getCurrent, Handlebars){
 		 * @body
 		 *
 		 * ## Use
-		 * 
+		 *
 		 * ```
 		 * {{{generatedWarning}}}
 		 * ```
-		 * 
+		 *
 		 * MUST use triple-braces to escape HTML so it is hidden in a comment.
 		 *
 		 * Creates a warning that looks like this:
@@ -230,7 +242,7 @@ module.exports = function(docMap, config, getCurrent, Handlebars){
 		},
 		/**
 		 * @function bit-docs-generate-html/build/make_default_helpers.makeTitle makeTitle
-		 * 
+		 *
 		 * Given the [bit-docs/types/docObject] context, returns a "pretty"
 		 * name that is used in the sidebar and the page header.
 		 */
@@ -288,13 +300,15 @@ module.exports = function(docMap, config, getCurrent, Handlebars){
 					//if there is anything in the hashParts, append it to the end of the url
 					href = urlTo(name) + (hashParts.length >= 1 ? ("#" + hashParts.join("#")) : "");
 
-					return '<a href="' + href + '" title="' + stripMarkdown(description) + '">' + linkText + '</a>';
+
+
+					return '<a href="' + href + '" title="' + stripMarkdown(description) + '">' + escapeOnlySingleElements( linkText ) + '</a>';
 				}
 
 				if (httpRegExp.test(name)) {
 					linkText = parts && parts[2] ? parts[2] : name;
 					href = name;
-					return '<a href="' + href + '" title="' + escape(linkText) + '">' + linkText + '</a>';
+					return '<a href="' + href + '" title="' + escape(linkText) + '">' + escapeOnlySingleElements( linkText ) + '</a>';
 				}
 
 				return match;

diff --git a/build/make_default_helpers_test.js b/build/make_default_helpers_test.js
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
   },
   "homepage": "https://github.com/bit-docs/bit-docs-generate-html#readme",
   "dependencies": {
+    "can-string": "0.0.5",
     "enpeem": "^2.1.0",
     "escape-html": "^1.0.3",
     "fs-extra": "0.30.0",