md-slides is a tool for presenting html-based presentations based on a Markdown documents.
Online Example (scrolling): astromechza.github.io/md-slides/
Project URL: github.com/astromechza/md-slides
Features:
- single static binary with no runtime dependencies
- no external javascript or css
- single & multipage modes
- supports embedding images
- uses
blackfridaymarkdown library - supports custom aspect-ratios and zooms
- prints to pdf well
-
many. Just Google "Markdown slides"
- reveal.js
- remark.js
- GitPitch
- etc..
-
But I believe in building software to meet your own needs, and reinventing the wheel for yourself can be some good fun.
-
And this provides a good balance between self-hosted, lock-in-free software, and feature-packed service offerings. While still making the slide source easily readable in its source or rendered markdown forms.
Although you can build and install it from source, we recommend that you pull the appropriate binary for your system from the project releases page here.
Or use the installation script to be quick:
$ curl https://raw.githubusercontent.com/astromechza/md-slides/master/install.sh | INSTALL_DIRECTORY=~/bin sh
Eg:
$ curl https://raw.githubusercontent.com/astromechza/md-slides/master/install.sh | INSTALL_DIRECTORY=~/bin sh
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 4390 100 4390 0 0 16473 0 --:--:-- --:--:-- --:--:-- 16819
ARCH = amd64
OS = darwin
Fetching https://github.com/astromechza/md-slides/releases/latest..
Release Tag = v0.1
Fetching https://github.com/astromechza/md-slides/releases/tag/v0.1..
Fetching https://github.com/astromechza/md-slides/releases/download/v0.1/md-slides.darwin.amd64..
Setting executable permissions.
Moving executable to /Users/benmeier/bin/md-slides
{embedcommand``: ["bash", "-c", "./md-slides --help || true"]}
{embedcommand: ["bash", "-c", "./md-slides --help || true"]}
{embedcommand: ["bash", "-c", "./md-slides serve --help || true"]}
{embedcommand: ["bash", "-c", "./md-slides html --help || true"]}
A single markdown document represents the multiple slides separated by a horizantal rule:
# this is slide one
stuff
---
# this is slide two
stuff
---
# this is slide three
stuffThe -mode flag can switch between display modes.
-
pagedis the default javascript-powered presentation mode with dynamic scaling. It attempts to scale to fit the presentation window while maintaining the slide aspect ratio and font size. It responds to key controls to advance slides. -
scrollingis a no-javascript mode with each slide below the other and with no dynamic scaling. This mode prints very well and has page hints for PDF rendering and export. This is also the mode used by the--export-toflag. It can be useful for distributing slides via email or embedding in other sites via an iframe.
Embed command embeds the combined stdout/stdin output of executing a given subcommand. The subcommand should be embeded as a json array like ["ls", "-al", "blah"].
For example a slide containing {embed``command: ["date"]} could output:
{embedcommand: ["date"]}
This makes it easy to present live content or to embed dynamic data into the slides based on the output of scripts.
To improve the sizing of images embedded into your slides, you can specify the width and height as url fragment parameters.
A number of meta tags are available to control formatting and alignment options.
They take the form of <meta a="blah" b="foo">.
They apply from the current slide onwards until they are overrident or reset with an empty string.
These meta tags control where in the slide the content is positioned. They are most effective when used to position content to the bottom or corners of a slide.
<meta valign="bottom" halign="left">Allowed values for valign are top, center, bottom
Allowed values for halign are left, center, right
Good for:
- title slides
- thank you slides
- slides containing centered images, questions, blocks, etc.
second line
The talign metadata should be used with halign and valign to direct the text-alignment of the slide.
<meta talign="left">Allowed values for talign are left, center, right
second line
Add some footer text to the bottom left of each slide using the footer metadata key.
The value will persist between pages until overriden by a new value or empty string.
<meta footer="January 1970 | Some Conference">This can be used to tweak the size and shape of one or more slides. This is useful for a number of things:
- adjusting aspect ratio
- extra wide slides
- zoom in or out to effectively change the font size
By default the resolution is 1600x900 but this can be changed by slides. Note that the resolution of the first slide is used to inform the primary size and shape of the slide deck.
<meta res="1600x900">Change the font color.
<meta fontcolor="#111">Change the background. Accepts colors, gradients, images, etc.
<meta background="#111">Anything that https://github.com/russross/blackfriday v2 supports.
- italic, bold,
strike - todo
- todo done
- links
- footnote links
- images
inline code- code blocks
- sublists
block quotes
package main
import "fmt"
func main() {
for i := 1; i <= 100; i++ {
result := ""
if i%3 == 0 { result += "Fizz" }
if i%5 == 0 { result += "Buzz" }
if result != "" {
fmt.Println(result)
continue
}
fmt.Println(i)
}
}| Tables | Are | Cool |
|---|---|---|
| col 1 is | left-aligned | $1600 |
| col 2 is | centered | $12 |
| col 3 is | right-aligned | $1 |
Text below image
Two choices:
-
Use
md-slides html ..to render to a directory and distribute asindex.htmlwith any images alongside it. -
Use Chrome to Menu → Print → Save as PDF to export the output of the
serve --mode=scrollingas a multi-page pdf.Although this is buggy and will probably not be perfect. PDF is hard!