StarMirror/showdown
1
0
Fork 0
mirror of https://github.com/showdownjs/showdown.git synced 2024-03-22 13:30:55 +08:00
Code Issues Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Estevao Soares dos Santos 2017-12-10 04:49:24 +00:00
parent cc19d9b3e0
commit a8427c9423
10 changed files with 89 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
dist/showdown.js vendored
View File

@ -1,4 +1,4 @@
;/*! showdown v 1.8.4 - 09-12-2017 */
;/*! showdown v 1.8.4 - 10-12-2017 */
(function(){
/**
* Created by Tivie on 13-07-2015.
@ -152,6 +152,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) {
@ -2438,6 +2443,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);
@ -2888,6 +2896,24 @@ showdown.subParser('codeSpans', function (text, options, globals) {
return text;
});
/**
* 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;
});
/**
* Convert all tabs to spaces
*/

2
dist/showdown.js.map vendored
View File

File diff suppressed because one or more lines are too long

4
dist/showdown.min.js vendored
View File

File diff suppressed because one or more lines are too long

2
dist/showdown.min.js.map vendored
View File

File diff suppressed because one or more lines are too long

3
src/converter.js
View File

@ -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);

5
src/options.js
View File

@ -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) {

17
src/subParsers/completeHTMLOutput.js Normal file
View File

@ -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;
});

14
test/features/completeHTMLOutput/simple.html Normal file
View File

@ -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>

7
test/features/completeHTMLOutput/simple.md Normal file
View File

@ -0,0 +1,7 @@
This is a **markdown** file
Converted into a full HTML document
- this
- is
- awesome

13
test/node/testsuite.features.js
View File

@ -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));
}
});
});