feat(completeHTMLOutput): add option to output a complete HTML document

showdownjs · Dec 10, 2017 · a8427c9 · a8427c9
1 parent cc19d9b
commit a8427c9
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 6 deletions.
diff --git a/dist/showdown.js b/dist/showdown.js
diff --git a/dist/showdown.js.map b/dist/showdown.js.map
diff --git a/dist/showdown.min.js b/dist/showdown.min.js
diff --git a/dist/showdown.min.js.map b/dist/showdown.min.js.map
diff --git a/src/converter.js b/src/converter.js
@@ -314,6 +314,9 @@ showdown.Converter = function (converterOptions) {
     // attacklab: Restore tremas
     text = text.replace(/¨T/g, '¨');
 
+    // render a complete html document instead of a partial if the option is enabled
+    text = showdown.subParser('completeHTMLOutput')(text, options, globals);
+
     // Run output modifiers
     showdown.helper.forEach(outputModifiers, function (ext) {
       text = showdown.subParser('runExtension')(ext, text, options, globals);

diff --git a/src/options.js b/src/options.js
@@ -150,6 +150,11 @@ function getDefaultOpts (simple) {
       defaultValue: false,
       description: 'Enable support for underline. Syntax is double or triple underscores: `__underline word__`. With this option enabled, underscores no longer parses into `<em>` and `<strong>`',
       type: 'boolean'
+    },
+    completeHTMLOutput: {
+      defaultValue: false,
+      description: 'Outputs a complete html document, including `<html>`, `<head>` and `<body>` tags',
+      type: 'boolean'
     }
   };
   if (simple === false) {

diff --git a/src/subParsers/completeHTMLOutput.js b/src/subParsers/completeHTMLOutput.js
@@ -0,0 +1,17 @@
+/**
+ * Turn Markdown link shortcuts into XHTML <a> tags.
+ */
+showdown.subParser('completeHTMLOutput', function (text, options, globals) {
+  'use strict';
+
+  if (!options.completeHTMLOutput) {
+    return text;
+  }
+
+  text = globals.converter._dispatch('completeHTMLOutput.before', text, options, globals);
+
+  text = '<html>\n<head>\n<meta charset="UTF-8">\n</head>\n<body>\n' + text.trim() + '\n</body>\n</html>';
+
+  text = globals.converter._dispatch('completeHTMLOutput.after', text, options, globals);
+  return text;
+});
diff --git a/test/features/completeHTMLOutput/simple.html b/test/features/completeHTMLOutput/simple.html
@@ -0,0 +1,14 @@
+<html>
+<head>
+ <meta charset="UTF-8">
+</head>
+<body>
+<p>This is a <strong>markdown</strong> file</p>
+<p>Converted into a full HTML document</p>
+<ul>
+ <li>this</li>
+ <li>is</li>
+ <li>awesome</li>
+</ul>
+</body>
+</html>
diff --git a/test/features/completeHTMLOutput/simple.md b/test/features/completeHTMLOutput/simple.md
@@ -0,0 +1,7 @@
+This is a **markdown** file
+
+Converted into a full HTML document
+
+ - this
+ - is
+ - awesome
diff --git a/test/node/testsuite.features.js b/test/node/testsuite.features.js
@@ -14,7 +14,8 @@ var bootstrap = require('../bootstrap.js'),
     emojisSuite = bootstrap.getTestSuite('test/features/emojis/'),
     underlineSuite = bootstrap.getTestSuite('test/features/underline/'),
     literalMidWordUnderscoresSuite = bootstrap.getTestSuite('test/features/literalMidWordUnderscores/'),
-    literalMidWordAsterisksSuite = bootstrap.getTestSuite('test/features/literalMidWordAsterisks/');
+    literalMidWordAsterisksSuite = bootstrap.getTestSuite('test/features/literalMidWordAsterisks/'),
+    completeHTMLOutputSuite = bootstrap.getTestSuite('test/features/completeHTMLOutput/');
 
 describe('makeHtml() features testsuite', function () {
   'use strict';
@@ -231,4 +232,14 @@ describe('makeHtml() features testsuite', function () {
       it(suite[i].name.replace(/-/g, ' '), assertion(suite[i], converter));
     }
   });
+
+  /** test completeHTMLOutput option **/
+  describe('completeHTMLOutput option', function () {
+    var converter,
+        suite = completeHTMLOutputSuite;
+    for (var i = 0; i < suite.length; ++i) {
+      converter = new showdown.Converter({completeHTMLOutput: true});
+      it(suite[i].name.replace(/-/g, ' '), assertion(suite[i], converter));
+    }
+  });
 });