summaryrefslogtreecommitdiffhomepage
path: root/plugin/markdown
diff options
context:
space:
mode:
authorHakim El Hattab2013-08-20 20:14:22 -0700
committerHakim El Hattab2013-08-20 20:14:22 -0700
commit4164200474e2af27803dc7683054f5443743c8a9 (patch)
tree40dbf6bcb8ef828c060cd39adff0589e6d7822c9 /plugin/markdown
parentcb26ff62112df74beb6ade2b4d3721d965f09c5d (diff)
parent2da7c3eacfcd7cc59d9cdee97087b0e2feca625e (diff)
Merge pull request #567 from hakimel/dev
2.5.0
Diffstat (limited to 'plugin/markdown')
-rw-r--r--plugin/markdown/example.html5
-rw-r--r--plugin/markdown/example.md2
-rwxr-xr-xplugin/markdown/markdown.js72
3 files changed, 56 insertions, 23 deletions
diff --git a/plugin/markdown/example.html b/plugin/markdown/example.html
index 1253cba..0b07aa5 100644
--- a/plugin/markdown/example.html
+++ b/plugin/markdown/example.html
@@ -16,7 +16,7 @@
<div class="slides">
- <!-- Use external markdown resource, and separate slides by three newlines; vertical slides by two newlines -->
+ <!-- Use external markdown resource, separate slides by three newlines; vertical slides by two newlines -->
<section data-markdown="example.md" data-separator="^\n\n\n" data-vertical="^\n\n"></section>
<!-- Slides are separated by three dashes (quick 'n dirty regular expression) -->
@@ -87,7 +87,8 @@
dependencies: [
{ src: '../../lib/js/classList.js', condition: function() { return !document.body.classList; } },
{ src: 'marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
- { src: 'markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }
+ { src: 'markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
+ { src: '../notes/notes.js' }
]
});
diff --git a/plugin/markdown/example.md b/plugin/markdown/example.md
index e988dd9..6f6f577 100644
--- a/plugin/markdown/example.md
+++ b/plugin/markdown/example.md
@@ -6,6 +6,8 @@
Content 1.1
+Note: This will only appear in the speaker notes window.
+
## External 1.2
diff --git a/plugin/markdown/markdown.js b/plugin/markdown/markdown.js
index 473666b..bc771e7 100755
--- a/plugin/markdown/markdown.js
+++ b/plugin/markdown/markdown.js
@@ -6,6 +6,14 @@
throw 'The reveal.js Markdown plugin requires marked to be loaded';
}
+ if (typeof hljs !== 'undefined') {
+ marked.setOptions({
+ highlight: function (lang, code) {
+ return hljs.highlightAuto(lang, code).value;
+ }
+ });
+ }
+
var stripLeadingWhitespace = function(section) {
var template = section.querySelector( 'script' );
@@ -28,7 +36,9 @@
};
var twrap = function(el) {
- return '<script type="text/template">' + el + '</script>';
+ var content = el.content || el;
+ content += el.asideContent ? ('<aside class="notes" data-markdown>' + el.asideContent + '</aside>') : '';
+ return '<script type="text/template">' + content + '</script>';
};
var getForwardedAttributes = function(section) {
@@ -40,7 +50,7 @@
value = attributes[i].value;
// disregard attributes that are used for markdown loading/parsing
- if( /data\-(markdown|separator|vertical)/gi.test( name ) ) continue;
+ if( /data\-(markdown|separator|vertical|notes)/gi.test( name ) ) continue;
if( value ) {
result.push( name + '=' + value );
@@ -51,47 +61,63 @@
}
return result.join( ' ' );
- }
+ };
- var slidifyMarkdown = function(markdown, separator, vertical, attributes) {
+ var slidifyMarkdown = function(markdown, separator, vertical, notes, attributes) {
separator = separator || '^\n---\n$';
+ notes = notes || 'note:';
- var reSeparator = new RegExp(separator + (vertical ? '|' + vertical : ''), 'mg'),
- reHorSeparator = new RegExp(separator),
+ var separatorRegex = new RegExp( separator + ( vertical ? '|' + vertical : '' ), 'mg' ),
+ horizontalSeparatorRegex = new RegExp( separator ),
+ notesSeparatorRegex = new RegExp( notes, 'mgi' ),
matches,
+ noteMatch,
lastIndex = 0,
isHorizontal,
wasHorizontal = true,
content,
+ asideContent,
+ slide,
sectionStack = [],
markdownSections = '';
// iterate until all blocks between separators are stacked up
- while( matches = reSeparator.exec(markdown) ) {
+ while( matches = separatorRegex.exec( markdown ) ) {
+ asideContent = null;
// determine direction (horizontal by default)
- isHorizontal = reHorSeparator.test(matches[0]);
+ isHorizontal = horizontalSeparatorRegex.test( matches[0] );
if( !isHorizontal && wasHorizontal ) {
// create vertical stack
- sectionStack.push([]);
+ sectionStack.push( [] );
}
// pluck slide content from markdown input
- content = markdown.substring(lastIndex, matches.index);
+ content = markdown.substring( lastIndex, matches.index );
+ noteMatch = content.split( notesSeparatorRegex );
+
+ if( noteMatch.length === 2 ) {
+ content = noteMatch[0];
+ asideContent = noteMatch[1].trim();
+ }
+
+ slide = {
+ content: content,
+ asideContent: asideContent || ""
+ };
if( isHorizontal && wasHorizontal ) {
// add to horizontal stack
- sectionStack.push(content);
+ sectionStack.push(slide);
} else {
// add to vertical stack
- sectionStack[sectionStack.length-1].push(content);
+ sectionStack[sectionStack.length-1].push(slide);
}
- lastIndex = reSeparator.lastIndex;
+ lastIndex = separatorRegex.lastIndex;
wasHorizontal = isHorizontal;
-
}
// add the remaining slide
@@ -99,15 +125,13 @@
// flatten the hierarchical stack, and insert <section data-markdown> tags
for( var k = 0, klen = sectionStack.length; k < klen; k++ ) {
- // horizontal
- if( typeof sectionStack[k] === 'string' ) {
- markdownSections += '<section '+ attributes +' data-markdown>' + twrap( sectionStack[k] ) + '</section>';
- }
// vertical
- else {
+ if( sectionStack[k].propertyIsEnumerable(length) && typeof sectionStack[k].splice === 'function' ) {
markdownSections += '<section '+ attributes +'>' +
'<section data-markdown>' + sectionStack[k].map(twrap).join('</section><section data-markdown>') + '</section>' +
'</section>';
+ } else {
+ markdownSections += '<section '+ attributes +' data-markdown>' + twrap( sectionStack[k] ) + '</section>';
}
}
@@ -128,10 +152,16 @@
var xhr = new XMLHttpRequest(),
url = section.getAttribute('data-markdown');
+ datacharset = section.getAttribute('data-charset');
+ // see https://developer.mozilla.org/en-US/docs/Web/API/element.getAttribute#Notes
+ if (datacharset != null && datacharset != '') {
+ xhr.overrideMimeType('text/html; charset=' + datacharset);
+ }
+
xhr.onreadystatechange = function () {
if( xhr.readyState === 4 ) {
if (xhr.status >= 200 && xhr.status < 300) {
- section.outerHTML = slidifyMarkdown( xhr.responseText, section.getAttribute('data-separator'), section.getAttribute('data-vertical'), getForwardedAttributes(section) );
+ section.outerHTML = slidifyMarkdown( xhr.responseText, section.getAttribute('data-separator'), section.getAttribute('data-vertical'), section.getAttribute('data-notes'), getForwardedAttributes(section) );
} else {
section.outerHTML = '<section data-state="alert">ERROR: The attempt to fetch ' + url + ' failed with the HTTP status ' + xhr.status +
'. Check your browser\'s JavaScript console for more details.' +
@@ -150,7 +180,7 @@
} else if( section.getAttribute('data-separator') ) {
var markdown = stripLeadingWhitespace(section);
- section.outerHTML = slidifyMarkdown( markdown, section.getAttribute('data-separator'), section.getAttribute('data-vertical'), getForwardedAttributes(section) );
+ section.outerHTML = slidifyMarkdown( markdown, section.getAttribute('data-separator'), section.getAttribute('data-vertical'), section.getAttribute('data-notes'), getForwardedAttributes(section) );
}
}