Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Markdown support. #78

Closed
wants to merge 4 commits into from
Closed

Add Markdown support. #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7442783
Add Markdown support.
tobie Sep 22, 2012
adf2ca7
Unescape > to fix broken support for block quotes.
tobie Sep 23, 2012
5af3ce8
Handles markdown content being nested inside elements with soft tabs.
tobie Sep 24, 2012
797f369
Notes and issues need not be paragraphs.
tobie Oct 16, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 208 additions & 0 deletions js/core/markdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
// Module core/markdown
// Handles the optional markdown processing.
//
// Markdown support is optional. It is enabled by setting the `format`
// property of the configuration object to "markdown."
//
// We use marked for parsing Markkdown.
//
// Note that the content of SECTION elements, and P elements with a
// class name of "note" or "issue" is also parsed.
//
// The HTML created by the Markdown parser is turned into a nested
// structure of SECTION elements, following the strucutre given by
// the headings. For example, the following markup:
//
// Title
// -----
//
// ### Subtitle ###
//
// Here's some text.
//
// ### Another subtitle ###
//
// More text.
//
// will be transformed into:
//
// <section>
// <h2>Title</h2>
// <section>
// <h3>Subtitle</h3>
// <p>Here's some text.</p>
// </section>
// <section>
// <h3>Another subtitle</h3>
// <p>More text.</p>
// </section>
// </section>

define(
['core/marked'],
function (markdown) {
marked.setOptions({
gfm: false,
pedantic: false,
sanitize: false
});

return {
toHTML: function(text) {
// As markdown is pulled from HTML > is already escaped, and
// thus blockquotes aren't picked up by the parser. This fixes
// it.
text = text.replace(/&gt;/g, '>');
text = this.removeLeftPadding(text);
return marked(text);
},

removeLeftPadding: function(text) {
// Handles markdown content being nested
// inside elements with soft tabs. E.g.:
// <div>
// This is a title
// ---------------
//
// And this more text.
// </div
//
// Gets turned into:
// <div>
// <h2>This is a title</h2>
// <p>And this more text.</p>
// </div
//
// Rather than:
// <div>
// <pre><code>This is a title
// ---------------
//
// And this more text.</code></pre>
// </div

var match = text.match(/\n[ ]+\S/g)
, current
, min
;

if (match) {
min = match[0].length - 2;
for (var i = 0, length = match.length; i < length; i++) {
current = match[i].length - 2;
if (typeof min == 'undefined' || min > current) {
min = current
}
}

var re = new RegExp("\n[ ]{0," + min + "}", "g");
text = text.replace(re, '\n');
}
return text;
},

processBody: function(doc) {
var fragment = doc.createDocumentFragment()
, div = doc.createElement('div')
, node
;

div.innerHTML = this.toHTML(doc.body.innerHTML);
while (node = div.firstChild) {
fragment.appendChild(node);
}
return fragment;
},

processSections: function(doc) {
var self = this;
$('section', doc).each(function() {
this.innerHTML = self.toHTML(this.innerHTML);
});
},

processIssuesAndNotes: function(doc) {
var div = doc.createElement('div');
var self = this;
$('.issue, .note', doc).each(function() {
div.innerHTML = self.toHTML(this.innerHTML);
this.innerHTML = '';
var node = div.firstChild;
while (node.firstChild) {
this.appendChild(node.firstChild);
}
});
},

structure: function(fragment, doc) {
var output = doc.createDocumentFragment()
, current = output
, stack = [output]
, node
, tagName
;

function newSection(node, position) {
var section = doc.createElement('section');
section.appendChild(node);
findParent(position).appendChild(section);
stack[position] = section;
current = section;
}

function findParent(position) {
while (1) {
position--
parent = stack[position];
if (parent) return parent;
}
}

while (node = fragment.firstChild) {
if (node.nodeType !== 1) {
fragment.removeChild(node);
continue;
}
tagName = node.tagName.toLowerCase();
switch (tagName) {
case 'h1':
newSection(node, 1);
break;
case 'h2':
newSection(node, 2);
break;
case 'h3':
newSection(node, 3);
break;
case 'h4':
newSection(node, 4);
break;
case 'h5':
newSection(node, 5);
break;
case 'h6':
newSection(node, 6);
break;
default:
current.appendChild(node);
}
}

return output;
},

run: function (conf, doc, cb, msg) {
msg.pub("start", "core/markdown");
if (conf.format === 'markdown') {
this.processIssuesAndNotes(doc);
this.processSections(doc);
fragment = this.structure(this.processBody(doc), doc);
doc.body.innerHTML = '';
doc.body.appendChild(fragment)
}
msg.pub("end", "core/markdown");
cb();
}
};
}
);
Loading