md2reveal

TOC

About

md2reveal tries to convert a markdown based slide into a html-presentation for reveal.js, which is a HTML Presentation Framework from Hakim El Hattab.

Screenshot

HowTo

• IN: the markdown file Markdown in and the menu/mathjax - checkbutton

• OUT: the HTML-file HTML out will be generated using the template file md2reval.temp in the subdirectory template.

• _in2out_: takeover the Markdown in file name for the HTML out file name. The extension will be *.html.

• Markdown - Extensions for slides

  • ---   → three dashes to separate slides
  • .notes: for Notes (press the S Button)
  • |||   → three vertical bars as a vertical seperator
    Note: The vertical seperator must be in front of the slide, where the vertical branching started. Use the normal seperator (→ three dashes), and the branching stops hopefully . . .
  • -|-   → a dash, a vertical bar and a dash as a seperator between different vertical sections.
  • Underline with === for the title of the presentation (→ title-tag)

See the Example (→ outcome) for more Information. An example for the -|- seperator is the Reveal Tutor.

config.json

You can edit and change the markdown extensions configuration in the JSON-file config.json

Checkbuttons

• MathJax: Support for MathJax (→ LaTeX-like Math-Formula).

  • Note: The Download of MathJax.js increases the load time.

• Menu: Support for reveal.js-menu, which is a nice Add-On for reveal.js.

Notes

• Without reveal.js the slide is a little bit ugly!

• The path to reveal.js in the generated HTML-file HTML out reflects my own installation. You should fix it to your own needs.

• The reveal.js-menu is from Greg Denehy. It must be installed separately.

• The proper use of md2reveal is based on the Python-Markdown module, which has to be installed first. Python-Markdown is a Python implementation of John Gruber’s Markdown.

• md2reveal is a python 2.7.x-script . . .

License

Copyright (C) 2017 Walter Spiegel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

→ sp, 2017-01-26, Vers. 010, Mail: walter [dot] spiegel [at] web [dot] de, md2reveal