summaryrefslogtreecommitdiffhomepage
path: root/plugin/markdown/markdown.js
diff options
context:
space:
mode:
authorChris Lawrence2013-08-26 02:25:38 -0400
committerChris Lawrence2013-08-26 02:25:38 -0400
commitd8fb09fb64aa238a2fecafadb3839b8491f919b5 (patch)
tree78012bb06d34f076cbf32c68974cd786f6f20cb4 /plugin/markdown/markdown.js
parentf84e025d38be24d7800d51bb8b117570c10568c2 (diff)
parentd62093c228f13ed10a21eb7055872b97c9f2ef78 (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'plugin/markdown/markdown.js')
-rwxr-xr-xplugin/markdown/markdown.js379
1 files changed, 230 insertions, 149 deletions
diff --git a/plugin/markdown/markdown.js b/plugin/markdown/markdown.js
index 473666b..31d22f1 100755
--- a/plugin/markdown/markdown.js
+++ b/plugin/markdown/markdown.js
@@ -1,190 +1,271 @@
-// From https://gist.github.com/1343518
-// Modified by Hakim to handle Markdown indented with tabs
+/**
+ * The reveal.js markdown plugin. Handles parsing of
+ * markdown inside of presentations as well as loading
+ * of external markdown documents.
+ */
(function(){
- if( typeof marked === 'undefined' ) {
- throw 'The reveal.js Markdown plugin requires marked to be loaded';
- }
+ if( typeof marked === 'undefined' ) {
+ 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;
+ }
+ });
+ }
+
+ /**
+ * Retrieves the markdown contents of a slide section
+ * element. Normalizes leading tabs/whitespace.
+ */
+ function getMarkdownFromSlide( section ) {
+
+ var template = section.querySelector( 'script' );
+
+ // strip leading whitespace so it isn't evaluated as code
+ var text = ( template || section ).textContent;
+
+ var leadingWs = text.match( /^\n?(\s*)/ )[1].length,
+ leadingTabs = text.match( /^\n?(\t*)/ )[1].length;
+
+ if( leadingTabs > 0 ) {
+ text = text.replace( new RegExp('\\n?\\t{' + leadingTabs + '}','g'), '\n' );
+ }
+ else if( leadingWs > 1 ) {
+ text = text.replace( new RegExp('\\n? {' + leadingWs + '}','g'), '\n' );
+ }
+
+ return text;
+
+ }
+
+ /**
+ * Given a markdown slide section element, this will
+ * return all arguments that aren't related to markdown
+ * parsing. Used to forward any other user-defined arguments
+ * to the output markdown slide.
+ */
+ function getForwardedAttributes( section ) {
+
+ var attributes = section.attributes;
+ var result = [];
+
+ for( var i = 0, len = attributes.length; i < len; i++ ) {
+ var name = attributes[i].name,
+ value = attributes[i].value;
+
+ // disregard attributes that are used for markdown loading/parsing
+ if( /data\-(markdown|separator|vertical|notes)/gi.test( name ) ) continue;
+
+ if( value ) {
+ result.push( name + '=' + value );
+ }
+ else {
+ result.push( name );
+ }
+ }
+
+ return result.join( ' ' );
+
+ }
+
+ /**
+ * Helper function for constructing a markdown slide.
+ */
+ function createMarkdownSlide( data ) {
+
+ var content = data.content || data;
+
+ if( data.notes ) {
+ content += '<aside class="notes" data-markdown>' + data.notes + '</aside>';
+ }
+
+ return '<script type="text/template">' + content + '</script>';
+
+ }
- var stripLeadingWhitespace = function(section) {
+ /**
+ * Parses a data string into multiple slides based
+ * on the passed in separator arguments.
+ */
+ function slidifyMarkdown( markdown, options ) {
+
+ options = options || {};
+ options.separator = options.separator || '^\n---\n$';
+ options.notesSeparator = options.notesSeparator || 'note:';
+ options.attributes = options.attributes || '';
- var template = section.querySelector( 'script' );
-
- // strip leading whitespace so it isn't evaluated as code
- var text = ( template || section ).textContent;
-
- var leadingWs = text.match(/^\n?(\s*)/)[1].length,
- leadingTabs = text.match(/^\n?(\t*)/)[1].length;
+ var separatorRegex = new RegExp( options.separator + ( options.verticalSeparator ? '|' + options.verticalSeparator : '' ), 'mg' ),
+ horizontalSeparatorRegex = new RegExp( options.separator ),
+ notesSeparatorRegex = new RegExp( options.notesSeparator, 'mgi' );
+
+ var matches,
+ noteMatch,
+ lastIndex = 0,
+ isHorizontal,
+ wasHorizontal = true,
+ content,
+ notes,
+ slide,
+ sectionStack = [];
+
+ // iterate until all blocks between separators are stacked up
+ while( matches = separatorRegex.exec( markdown ) ) {
+ notes = null;
+
+ // determine direction (horizontal by default)
+ isHorizontal = horizontalSeparatorRegex.test( matches[0] );
+
+ if( !isHorizontal && wasHorizontal ) {
+ // create vertical stack
+ sectionStack.push( [] );
+ }
+
+ // pluck slide content from markdown input
+ content = markdown.substring( lastIndex, matches.index );
+ noteMatch = content.split( notesSeparatorRegex );
+
+ if( noteMatch.length === 2 ) {
+ content = noteMatch[0];
+ notes = noteMatch[1].trim();
+ }
+
+ slide = {
+ content: content,
+ notes: notes || ''
+ };
+
+ if( isHorizontal && wasHorizontal ) {
+ // add to horizontal stack
+ sectionStack.push( slide );
+ }
+ else {
+ // add to vertical stack
+ sectionStack[sectionStack.length-1].push( slide );
+ }
- if( leadingTabs > 0 ) {
- text = text.replace( new RegExp('\\n?\\t{' + leadingTabs + '}','g'), '\n' );
- }
- else if( leadingWs > 1 ) {
- text = text.replace( new RegExp('\\n? {' + leadingWs + '}','g'), '\n' );
- }
+ lastIndex = separatorRegex.lastIndex;
+ wasHorizontal = isHorizontal;
+ }
- return text;
+ // add the remaining slide
+ ( wasHorizontal ? sectionStack : sectionStack[sectionStack.length-1] ).push( markdown.substring( lastIndex ) );
- };
+ var markdownSections = '';
- var twrap = function(el) {
- return '<script type="text/template">' + el + '</script>';
- };
+ // flatten the hierarchical stack, and insert <section data-markdown> tags
+ for( var i = 0, len = sectionStack.length; i < len; i++ ) {
+ // vertical
+ if( sectionStack[i].propertyIsEnumerable( length ) && typeof sectionStack[i].splice === 'function' ) {
+ markdownSections += '<section '+ options.attributes +'>' +
+ '<section data-markdown>' + sectionStack[i].map( createMarkdownSlide ).join( '</section><section data-markdown>' ) + '</section>' +
+ '</section>';
+ }
+ else {
+ markdownSections += '<section '+ options.attributes +' data-markdown>' + createMarkdownSlide( sectionStack[i] ) + '</section>';
+ }
+ }
- var getForwardedAttributes = function(section) {
- var attributes = section.attributes;
- var result = [];
+ return markdownSections;
- for( var i = 0, len = attributes.length; i < len; i++ ) {
- var name = attributes[i].name,
- value = attributes[i].value;
+ }
- // disregard attributes that are used for markdown loading/parsing
- if( /data\-(markdown|separator|vertical)/gi.test( name ) ) continue;
+ function loadExternalMarkdown() {
- if( value ) {
- result.push( name + '=' + value );
- }
- else {
- result.push( name );
- }
- }
+ var sections = document.querySelectorAll( '[data-markdown]'),
+ section;
- return result.join( ' ' );
- }
+ for( var i = 0, len = sections.length; i < len; i++ ) {
- var slidifyMarkdown = function(markdown, separator, vertical, attributes) {
+ section = sections[i];
- separator = separator || '^\n---\n$';
+ if( section.getAttribute( 'data-markdown' ).length ) {
- var reSeparator = new RegExp(separator + (vertical ? '|' + vertical : ''), 'mg'),
- reHorSeparator = new RegExp(separator),
- matches,
- lastIndex = 0,
- isHorizontal,
- wasHorizontal = true,
- content,
- sectionStack = [],
- markdownSections = '';
+ var xhr = new XMLHttpRequest(),
+ url = section.getAttribute( 'data-markdown' );
- // iterate until all blocks between separators are stacked up
- while( matches = reSeparator.exec(markdown) ) {
+ datacharset = section.getAttribute( 'data-charset' );
- // determine direction (horizontal by default)
- isHorizontal = reHorSeparator.test(matches[0]);
+ // see https://developer.mozilla.org/en-US/docs/Web/API/element.getAttribute#Notes
+ if( datacharset != null && datacharset != '' ) {
+ xhr.overrideMimeType( 'text/html; charset=' + datacharset );
+ }
- if( !isHorizontal && wasHorizontal ) {
- // create vertical stack
- sectionStack.push([]);
- }
+ xhr.onreadystatechange = function() {
+ if( xhr.readyState === 4 ) {
+ if ( xhr.status >= 200 && xhr.status < 300 ) {
- // pluck slide content from markdown input
- content = markdown.substring(lastIndex, matches.index);
+ section.outerHTML = slidifyMarkdown( xhr.responseText, {
+ separator: section.getAttribute( 'data-separator' ),
+ verticalSeparator: section.getAttribute( 'data-vertical' ),
+ notesSeparator: section.getAttribute( 'data-notes' ),
+ attributes: getForwardedAttributes( section )
+ });
- if( isHorizontal && wasHorizontal ) {
- // add to horizontal stack
- sectionStack.push(content);
- } else {
- // add to vertical stack
- sectionStack[sectionStack.length-1].push(content);
- }
+ }
+ else {
- lastIndex = reSeparator.lastIndex;
- wasHorizontal = isHorizontal;
+ section.outerHTML = '<section data-state="alert">' +
+ 'ERROR: The attempt to fetch ' + url + ' failed with HTTP status ' + xhr.status + '.' +
+ 'Check your browser\'s JavaScript console for more details.' +
+ '<p>Remember that you need to serve the presentation HTML from a HTTP server.</p>' +
+ '</section>';
- }
+ }
+ }
+ };
- // add the remaining slide
- (wasHorizontal ? sectionStack : sectionStack[sectionStack.length-1]).push(markdown.substring(lastIndex));
+ xhr.open( 'GET', url, false );
- // 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 {
- markdownSections += '<section '+ attributes +'>' +
- '<section data-markdown>' + sectionStack[k].map(twrap).join('</section><section data-markdown>') + '</section>' +
- '</section>';
- }
- }
+ try {
+ xhr.send();
+ }
+ catch ( e ) {
+ alert( 'Failed to get the Markdown file ' + url + '. Make sure that the presentation and the file are served by a HTTP server and the file can be found there. ' + e );
+ }
- return markdownSections;
- };
+ }
+ else if( section.getAttribute( 'data-separator' ) ) {
- var querySlidingMarkdown = function() {
+ section.outerHTML = slidifyMarkdown( getMarkdownFromSlide( section ), {
+ separator: section.getAttribute( 'data-separator' ),
+ verticalSeparator: section.getAttribute( 'data-vertical' ),
+ notesSeparator: section.getAttribute( 'data-notes' ),
+ attributes: getForwardedAttributes( section )
+ });
- var sections = document.querySelectorAll( '[data-markdown]'),
- section;
+ }
+ }
- for( var j = 0, jlen = sections.length; j < jlen; j++ ) {
+ }
- section = sections[j];
+ function convertMarkdownToHTML() {
- if( section.getAttribute('data-markdown').length ) {
+ var sections = document.querySelectorAll( '[data-markdown]');
- var xhr = new XMLHttpRequest(),
- url = section.getAttribute('data-markdown');
+ for( var i = 0, len = sections.length; i < len; i++ ) {
- 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) );
- } 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.' +
- '<p>Remember that you need to serve the presentation HTML from a HTTP server and the Markdown file must be there too.</p></section>';
- }
- }
- };
+ var section = sections[i];
- xhr.open('GET', url, false);
- try {
- xhr.send();
- } catch (e) {
- alert('Failed to get the Markdown file ' + url + '. Make sure that the presentation and the file are served by a HTTP server and the file can be found there. ' + e);
- }
+ var notes = section.querySelector( 'aside.notes' );
+ var markdown = getMarkdownFromSlide( section );
- } else if( section.getAttribute('data-separator') ) {
+ section.innerHTML = marked( markdown );
- var markdown = stripLeadingWhitespace(section);
- section.outerHTML = slidifyMarkdown( markdown, section.getAttribute('data-separator'), section.getAttribute('data-vertical'), getForwardedAttributes(section) );
+ // If there were notes, we need to re-add them after
+ // having overwritten the section's HTML
+ if( notes ) {
+ section.appendChild( notes );
+ }
- }
- }
+ }
- };
+ }
- var queryMarkdownSlides = function() {
-
- var sections = document.querySelectorAll( '[data-markdown]');
-
- for( var j = 0, jlen = sections.length; j < jlen; j++ ) {
-
- makeHtml(sections[j]);
-
- }
-
- };
-
- var makeHtml = function(section) {
-
- var notes = section.querySelector( 'aside.notes' );
-
- var markdown = stripLeadingWhitespace(section);
-
- section.innerHTML = marked(markdown);
-
- if( notes ) {
- section.appendChild( notes );
- }
-
- };
-
- querySlidingMarkdown();
-
- queryMarkdownSlides();
+ loadExternalMarkdown();
+ convertMarkdownToHTML();
})();