PrezDown
========
Automagically transform a markdown file into a slideshow.
Installation
------------
- Make sure you have NodeJS installed:
- Install the tool using npm
~~~
$ (sudo) npm install -g prezdown
~~~
Usage
-----
$3
To create multiple slides, put an horizontal line (using at least 3 dash signs). The horizontal line must be on its own line, with an empty line before and after.
_Example:_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Page 1
======
This will be the first page
------------------------------
Page 2
======
This will be the second page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
$3
~~~
$ prezdown somefile.md
~~~
$3
The resulting html file and the required assets will be placed in the
output directory.
Options
-------
$3
Set how slides should change (auto, keyboard, both).
By default, or if the mode is set to something other than
auto or
keyboard, both methods are used.
$3
Do not compile, just remove the output directory.
Clean is always performed before a build.
$3
Choose the theme. A theme is simply a CSS file inside the themes directory.
The file name must be in the format
.min.css
$3
Set the number of milliseconds to wait before slide changes.
By default, the value is 5000ms (5s).$3
Choose the title of the slideshow. This is used in the of the output</p><p class="my-3">Assets<br />------</p><p class="my-3">You can add images or other files in the <code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">assets</code> directory. The directory must be in the same folder as the markdown file. Place the files in assets, without further subdirectories.</p><p class="my-3">All the files in the <code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">assets</code> directory will be copied into the <code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">output</code> folder when building.</p><p class="my-3">Libraries<br />---------</p><p class="my-3">The final HTML page will use the following libraries:</p><p class="my-3">- jquery: <https://github.com/jquery/jquery><br />- highlightjs: <https://github.com/isagalaev/highlight.js><br /></p></div></div></div><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div><template id="P:3"></template></div></div></div><div hidden id="S:3"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><script>$RC("B:1","S:1")</script></body></html>