markdown.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. /**
  2. * The reveal.js markdown plugin. Handles parsing of
  3. * markdown inside of presentations as well as loading
  4. * of external markdown documents.
  5. */
  6. (function( root, factory ) {
  7. if( typeof exports === 'object' ) {
  8. module.exports = factory( require( './marked' ) );
  9. }
  10. else {
  11. // Browser globals (root is window)
  12. root.RevealMarkdown = factory( root.marked );
  13. root.RevealMarkdown.initialize();
  14. }
  15. }( this, function( marked ) {
  16. if( typeof marked === 'undefined' ) {
  17. throw 'The reveal.js Markdown plugin requires marked to be loaded';
  18. }
  19. if( typeof hljs !== 'undefined' ) {
  20. marked.setOptions({
  21. highlight: function( lang, code ) {
  22. return hljs.highlightAuto( lang, code ).value;
  23. }
  24. });
  25. }
  26. var DEFAULT_SLIDE_SEPARATOR = '^\n---\n$',
  27. DEFAULT_NOTES_SEPARATOR = 'note:',
  28. DEFAULT_ELEMENT_ATTRIBUTES_SEPARATOR = '{\\\.\s*?([^}]+?)}',
  29. DEFAULT_SLIDE_ATTRIBUTES_SEPARATOR = '^.*?<!--\sslide-attributes:\s(.*?)-->';
  30. /**
  31. * Retrieves the markdown contents of a slide section
  32. * element. Normalizes leading tabs/whitespace.
  33. */
  34. function getMarkdownFromSlide( section ) {
  35. var template = section.querySelector( 'script' );
  36. // strip leading whitespace so it isn't evaluated as code
  37. var text = ( template || section ).textContent;
  38. var leadingWs = text.match( /^\n?(\s*)/ )[1].length,
  39. leadingTabs = text.match( /^\n?(\t*)/ )[1].length;
  40. if( leadingTabs > 0 ) {
  41. text = text.replace( new RegExp('\\n?\\t{' + leadingTabs + '}','g'), '\n' );
  42. }
  43. else if( leadingWs > 1 ) {
  44. text = text.replace( new RegExp('\\n? {' + leadingWs + '}','g'), '\n' );
  45. }
  46. return text;
  47. }
  48. /**
  49. * Given a markdown slide section element, this will
  50. * return all arguments that aren't related to markdown
  51. * parsing. Used to forward any other user-defined arguments
  52. * to the output markdown slide.
  53. */
  54. function getForwardedAttributes( section ) {
  55. var attributes = section.attributes;
  56. var result = [];
  57. for( var i = 0, len = attributes.length; i < len; i++ ) {
  58. var name = attributes[i].name,
  59. value = attributes[i].value;
  60. // disregard attributes that are used for markdown loading/parsing
  61. if( /data\-(markdown|separator|vertical|notes|attributes)/gi.test( name ) ) continue;
  62. if( value ) {
  63. result.push( name + '=' + value );
  64. }
  65. else {
  66. result.push( name );
  67. }
  68. }
  69. return result.join( ' ' );
  70. }
  71. /**
  72. * Inspects the given options and fills out default
  73. * values for what's not defined.
  74. */
  75. function getSlidifyOptions( options ) {
  76. options = options || {};
  77. options.separator = options.separator || DEFAULT_SLIDE_SEPARATOR;
  78. options.notesSeparator = options.notesSeparator || DEFAULT_NOTES_SEPARATOR;
  79. options.attributes = options.attributes || '';
  80. options.slideAttributesSeparator = options.slideAttributesSeparator || DEFAULT_SLIDE_ATTRIBUTES_SEPARATOR;
  81. return options;
  82. }
  83. /**
  84. * Helper function for constructing a markdown slide.
  85. */
  86. function createMarkdownSlide( content, options ) {
  87. options = getSlidifyOptions( options );
  88. var notesMatch = content.split( new RegExp( options.notesSeparator, 'mgi' ) );
  89. if( notesMatch.length === 2 ) {
  90. content = notesMatch[0] + '<aside class="notes" data-markdown>' + notesMatch[1].trim() + '</aside>';
  91. }
  92. return '<script type="text/template">' + content + '</script>';
  93. }
  94. /**
  95. * Parses a data string into multiple slides based
  96. * on the passed in separator arguments.
  97. */
  98. function slidify( markdown, options ) {
  99. options = getSlidifyOptions( options );
  100. var separatorRegex = new RegExp( options.separator + ( options.verticalSeparator ? '|' + options.verticalSeparator : '' ), 'mg' ),
  101. horizontalSeparatorRegex = new RegExp( options.separator ),
  102. slideAttributesSeparatorRegex = new RegExp( options.slideAttributesSeparator, 'm' );
  103. var matches,
  104. lastIndex = 0,
  105. isHorizontal,
  106. wasHorizontal = true,
  107. content,
  108. sectionStack = [],
  109. matchAttributes,
  110. slideAttributes = "";
  111. // iterate until all blocks between separators are stacked up
  112. while( matches = separatorRegex.exec( markdown ) ) {
  113. notes = null;
  114. // determine direction (horizontal by default)
  115. isHorizontal = horizontalSeparatorRegex.test( matches[0] );
  116. if( !isHorizontal && wasHorizontal ) {
  117. // create vertical stack
  118. sectionStack.push( [] );
  119. }
  120. // pluck slide content from markdown input
  121. content = markdown.substring( lastIndex, matches.index );
  122. if( isHorizontal && wasHorizontal ) {
  123. // add to horizontal stack
  124. sectionStack.push( content );
  125. }
  126. else {
  127. // add to vertical stack
  128. sectionStack[sectionStack.length-1].push( content );
  129. }
  130. lastIndex = separatorRegex.lastIndex;
  131. wasHorizontal = isHorizontal;
  132. }
  133. // add the remaining slide
  134. ( wasHorizontal ? sectionStack : sectionStack[sectionStack.length-1] ).push( markdown.substring( lastIndex ) );
  135. var markdownSections = '';
  136. // flatten the hierarchical stack, and insert <section data-markdown> tags
  137. for( var i = 0, len = sectionStack.length; i < len; i++ ) {
  138. // vertical
  139. if( sectionStack[i] instanceof Array ) {
  140. // The 'data-xxx' attributes of the first child must be set on the wrapping parent section to be effective
  141. // Mainly for data-transition (otherwise, it is ignored for the first vertical slide)
  142. firstChild = sectionStack[i][0];
  143. matchAttributes = slideAttributesSeparatorRegex.exec( firstChild );
  144. slideAttributes = matchAttributes ? matchAttributes[1] : "";
  145. dataAttributes = "";
  146. if( slideAttributes != "" ) {
  147. // console.log('all attr=' + slideAttributes );
  148. // http://stackoverflow.com/questions/18025762/javascript-regex-replace-all-word-characters-except-word-characters-between-ch
  149. // Keep only data-attributes for the parent slide section.
  150. dataAttributes = slideAttributes.replace( /(data-\S+=\"[^\"]+?\")|\w|[\"=]/g, function(a, b) { return b || ''; });
  151. // console.log('new attr=' + dataAttributes );
  152. }
  153. markdownSections += '<section '+ options.attributes + ' ' + dataAttributes + '>';
  154. sectionStack[i].forEach( function( child ) {
  155. matchAttributes = slideAttributesSeparatorRegex.exec( child );
  156. slideAttributes = matchAttributes ? matchAttributes[1] : "";
  157. child = matchAttributes ? child.replace( slideAttributesSeparatorRegex,"" ) : child
  158. // console.log('slide attributes ' + options.slideAttributesSeparator + ' => ' + slideAttributes)
  159. markdownSections += '<section ' + slideAttributes + ' data-markdown>' + createMarkdownSlide( child, options ) + '</section>';
  160. } );
  161. markdownSections += '</section>';
  162. }
  163. else {
  164. matchAttributes = slideAttributesSeparatorRegex.exec( sectionStack[i] );
  165. slideAttributes = matchAttributes ? matchAttributes[1] : "";
  166. content = matchAttributes ? sectionStack[i].replace( slideAttributesSeparatorRegex,"" ) : sectionStack[i]
  167. //console.log('Slide attributes ' + options.slideAttributesSeparator + ' => ' + slideAttributes)
  168. markdownSections += '<section '+ options.attributes + ' ' + slideAttributes +' data-markdown>' + createMarkdownSlide( content, options ) + '</section>';
  169. }
  170. }
  171. return markdownSections;
  172. }
  173. /**
  174. * Parses any current data-markdown slides, splits
  175. * multi-slide markdown into separate sections and
  176. * handles loading of external markdown.
  177. */
  178. function processSlides() {
  179. var sections = document.querySelectorAll( '[data-markdown]'),
  180. section;
  181. for( var i = 0, len = sections.length; i < len; i++ ) {
  182. section = sections[i];
  183. if( section.getAttribute( 'data-markdown' ).length ) {
  184. var xhr = new XMLHttpRequest(),
  185. url = section.getAttribute( 'data-markdown' );
  186. datacharset = section.getAttribute( 'data-charset' );
  187. // see https://developer.mozilla.org/en-US/docs/Web/API/element.getAttribute#Notes
  188. if( datacharset != null && datacharset != '' ) {
  189. xhr.overrideMimeType( 'text/html; charset=' + datacharset );
  190. }
  191. xhr.onreadystatechange = function() {
  192. if( xhr.readyState === 4 ) {
  193. if ( xhr.status >= 200 && xhr.status < 300 ) {
  194. section.outerHTML = slidify( xhr.responseText, {
  195. separator: section.getAttribute( 'data-separator' ),
  196. verticalSeparator: section.getAttribute( 'data-vertical' ),
  197. notesSeparator: section.getAttribute( 'data-notes' ),
  198. attributes: getForwardedAttributes( section ),
  199. slideAttributesSeparator: section.getAttribute( 'data-attributes' ),
  200. });
  201. }
  202. else {
  203. section.outerHTML = '<section data-state="alert">' +
  204. 'ERROR: The attempt to fetch ' + url + ' failed with HTTP status ' + xhr.status + '.' +
  205. 'Check your browser\'s JavaScript console for more details.' +
  206. '<p>Remember that you need to serve the presentation HTML from a HTTP server.</p>' +
  207. '</section>';
  208. }
  209. }
  210. };
  211. xhr.open( 'GET', url, false );
  212. try {
  213. xhr.send();
  214. }
  215. catch ( e ) {
  216. 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 );
  217. }
  218. }
  219. else if( section.getAttribute( 'data-separator' ) || section.getAttribute( 'data-vertical' ) || section.getAttribute( 'data-notes' ) ) {
  220. section.outerHTML = slidify( getMarkdownFromSlide( section ), {
  221. separator: section.getAttribute( 'data-separator' ),
  222. verticalSeparator: section.getAttribute( 'data-vertical' ),
  223. notesSeparator: section.getAttribute( 'data-notes' ),
  224. attributes: getForwardedAttributes( section )
  225. });
  226. }
  227. else {
  228. section.innerHTML = createMarkdownSlide( getMarkdownFromSlide( section ) );
  229. }
  230. }
  231. }
  232. /**
  233. * Check if a node value has the attributes pattern.
  234. * If yes, extract it and add that value as one or several attributes
  235. * the the terget element.
  236. *
  237. * You need Cache Killer on Chrome to see the effect on any FOM transformation
  238. * directly on refresh (F5)
  239. * http://stackoverflow.com/questions/5690269/disabling-chrome-cache-for-website-development/7000899#answer-11786277
  240. */
  241. function addAttributeInElement( node, elementTarget, separator ) {
  242. var mardownClassesInElementsRegex = new RegExp( separator, 'mg' );
  243. var mardownClassRegex = new RegExp( "([^\"= ]+?)=\"([^\"=]+?)\"", 'mg' );
  244. var nodeValue = node.nodeValue;
  245. if( matches = mardownClassesInElementsRegex.exec( nodeValue ) ) {
  246. var classes = matches[1];
  247. nodeValue = nodeValue.substring( 0, matches.index ) + nodeValue.substring( mardownClassesInElementsRegex.lastIndex );
  248. node.nodeValue = nodeValue;
  249. while( matchesClass = mardownClassRegex.exec( classes ) ) {
  250. elementTarget.setAttribute( matchesClass[1], matchesClass[2] );
  251. }
  252. }
  253. }
  254. /**
  255. * Add attributes to the parent element of a text node,
  256. * or the element of an attribute node.
  257. */
  258. function addAttributes( element, separator ) {
  259. if( element.childNodes.length > 0 ) {
  260. for( var i = 0; i < element.childNodes.length; i++ ) {
  261. addAttributes( element.childNodes[i], separator );
  262. }
  263. }
  264. var nodeValue;
  265. var elementTarget;
  266. // From http://stackoverflow.com/questions/9178174/find-all-text-nodes
  267. if( element.nodeType == Node.TEXT_NODE && /\S/.test(element.nodeValue) ) {
  268. addAttributeInElement( element, element.parentNode, separator );
  269. }
  270. if( element.nodeType == Node.ELEMENT_NODE && element.attributes.length > 0 ) {
  271. for( var j = 0; j < element.attributes.length; j++ ){
  272. var attr = element.attributes[j];
  273. addAttributeInElement( attr, element, separator );
  274. }
  275. }
  276. }
  277. /**
  278. * Converts any current data-markdown slides in the
  279. * DOM to HTML.
  280. */
  281. function convertSlides() {
  282. var sections = document.querySelectorAll( '[data-markdown]');
  283. for( var i = 0, len = sections.length; i < len; i++ ) {
  284. var section = sections[i];
  285. // Only parse the same slide once
  286. if( !section.getAttribute( 'data-markdown-parsed' ) ) {
  287. section.setAttribute( 'data-markdown-parsed', true )
  288. var notes = section.querySelector( 'aside.notes' );
  289. var markdown = getMarkdownFromSlide( section );
  290. section.innerHTML = marked( markdown );
  291. addAttributes( section, section.getAttribute( 'data-element-attributes' ) ||
  292. section.parentNode.getAttribute( 'data-element-attributes' ) ||
  293. DEFAULT_ELEMENT_ATTRIBUTES_SEPARATOR );
  294. // If there were notes, we need to re-add them after
  295. // having overwritten the section's HTML
  296. if( notes ) {
  297. section.appendChild( notes );
  298. }
  299. }
  300. }
  301. }
  302. // API
  303. return {
  304. initialize: function() {
  305. processSlides();
  306. convertSlides();
  307. },
  308. // TODO: Do these belong in the API?
  309. processSlides: processSlides,
  310. convertSlides: convertSlides,
  311. slidify: slidify
  312. };
  313. }));