How to use Markdown to make beautiful presentations with Deckset
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
logo.png

README.md

Deckset Tutorial

How to use Markdown to make beautiful presentations

Open this file in your favorite text editor and in the Deckset application. I recommend that you view the tutorial using the Plain Jane theme to start with, as not all themes support all styling options. You can switch back and forth between editor and app to see how the Markdown is converted into slides, making experimental adjustments as you see fit. Or, if you tell Deckset which editor you like to use, it will provide a picture-in-picture window for you (GUI editors only). Enjoy.

^ Note: if you are viewing this file on GitHub, everything after this point will look weird.


[fit] Deckset with Markdown

Tutorial


or

Deckset with Markdown

[fit] Tutorial


or

[fit] Deckset with Markdown

[fit] Tutorial


Steven Syrek

steven.syrek@gmail.com

Steven Syrek

steven.syrek@gmail.com

steven.syrek@gmail.com

steven.syrek@gmail.com


Start a new slide with a blank line, three dashes, and another blank line


Smart copy & paste

To copy a slide from Deckset to another document, just ⌘+C it, then ⌘+V it into your editor (it will paste the Markdown) or into any application that handles PDFs (it will paste the slide as PDF).


You can include inspirational quotes


You miss 100 percent of the shots you never take. -- Wayne Gretzky


Or (this one is inline) quotes that are actually interesting:

'I'm bored' is a useless thing to say. You live in a great, big, vast world that you've seen none percent of. Even the inside of your own mind is endless; it goes on forever, inwardly, do you understand? The fact that you're alive is amazing. So you don't get to be bored.

-- Louis C. K.


[fit] Fit text to the slide like this


You can also include notes for yourself in the Markdown file that won't display on the slide

^ This text will not appear on the slide.


Line breaks

Put your line breaks wherever you want

Also works in
headers if you use the <br> HTML tag


Emojis

You can use GitHub style emojis:

💩 😡 🔥 😱 👎 😾 👸 😋 😅 🐹 🌺 🍉


  1. Ordered list
  2. Use a 1 on every line
  3. And they will be given the correct sequence
  • Unordered list
  • Use any of these three characters
  • And you will get a bulleted list

  • Nested lists are also possible
    1. indent each item 4 spaces
      • here's another nested list
    2. back to this level
    3. and another item
      1. a numbered list, nested
      2. another nested item
  • And back to the top

You embolden text like this or like this You emphasize text like this or like this Or do both at the same time You can also strikethrough text

This is Subscript text This is Superscript text

Center text like this

Center headings like this


Normal Heading 1

Normal Heading 2

Normal Heading 3

Normal Heading 4


Emphasized Heading 1

Emphasized Heading 2

Emphasized Heading 3

Emphasized Heading 4


Emboldened Heading 1

Emboldened Heading 2

Emboldened Heading 3

Emboldened Heading 4


Strikethrough Heading 1

Strikethrough Heading 2

Strikethrough Heading 3

Strikethrough Heading 4


You can write code inline by using backticks. For example, if you want to mention in passing that the monadic bind operation in Haskell has the type signature (>>=) :: forall a b. m a -> (a -> m b) -> m b.


Or you can use code blocks for longer examples, which use triple backticks and support syntax highlighting (as on GitHub):

instance Functor Maybe where
    fmap _ Nothing      = Nothing
    fmap f (Just a)     = Just (f a)

instance Applicative Maybe where
    pure = Just

    Just f  <*> m       = fmap f m
    Nothing <*> _m      = Nothing

    Just _m1 *> m2      = m2
    Nothing  *> _m2     = Nothing

instance  Monad Maybe where
    (Just x) >>= k      = k x
    Nothing  >>= _      = Nothing

    (>>) = (*>)

    fail _              = Nothing

Yeah, yeah, I know you want to see JavaScript:

var docCookies = new Proxy(docCookies, {
  get: function (oTarget, sKey) {
    return oTarget[sKey] || oTarget.getItem(sKey) || undefined;
  },
  set: function (oTarget, sKey, vValue) {
    if (sKey in oTarget) { return false; }
    return oTarget.setItem(sKey, vValue);
  },
  deleteProperty: function (oTarget, sKey) {
    if (sKey in oTarget) { return false; }
    return oTarget.removeItem(sKey);
  },
  enumerate: function (oTarget, sKey) {
    return oTarget.keys();
  },
  ownKeys: function (oTarget, sKey) {
    return oTarget.keys();
  },
  has: function (oTarget, sKey) {
    return sKey in oTarget || oTarget.hasItem(sKey);
  },
  defineProperty: function (oTarget, sKey, oDesc) {
    if (oDesc && "value" in oDesc) { oTarget.setItem(sKey, oDesc.value); }
    return oTarget;
  },
  getOwnPropertyDescriptor: function (oTarget, sKey) {
    var vValue = oTarget.getItem(sKey);
    return vValue ? {
      value: vValue,
      writable: true,
      enumerable: true,
      configurable: false
    } : undefined;
  },
});

[fit] Images

Images can appear in a variety of ways.

First, alone.



Slide with an image and text overlay, filtered


Slide with an image and text overlay, unfiltered

original


inline

You can use the [inline] modifier to add a caption to your image like this


[fit] inline

Image with a bigger caption...


...or heading

[fit] inline


You can also have images fill a slide (the default behavior), fit to a slide, scale up or down, align left or right, and appear filtered for a cool special effect (demonstrated on the following slides)



fit


300%


25%


left


right


filtered


Images used inline scale to fit the size of the surrounding text:

Heading with inline inline image


[fit] Fit inline heading


You can also create rows of images (make sure to insert a blank line to create a new paragraph):

inline inline inline


Or a grid:

inlineinline inlineinline


Or a grid with space between the lines:

inlineinline

inlineinline


Create neat effects by combining these techniques

fill

inlineinlineinline


fill inline inlineinlineinline


inlinefill inline 300%


You can also embed videos into your presentations (local or from YouTube)



You can inline them, too

inline


Video on the left

left


Video on the right

right


Video fill

fill


Video size by Percentage (50%)

50%


Video size by Percentage (200%)

200%


Combine playback options

left autoplay mute loop


You can have footnotes, too, if you must

This is some text that I would like to footnote[^1].

[^1]: This is the footnote (but do you really need footnotes on your slides?).


Name references for footnotes, if you must

This is a reference to something[^Syrek, 2016].

[^Syrek, 2016]: I'm obviously not a fan of footnotes in slides.


There is also support for math using

$$ \LaTeX $$

Which, if you know how to use it, you are excited about:

$$ \begin{matrix} \left( \frac{1 + x}{2 + y^{2}} \right)^{2} & \left[ \frac{1 + x}{2 + y^{2}} \right]^{2} & \left{ \frac{1 + x}{2 + y^{2}} \right}^{2} & \left| \frac{1 + x}{2 + y^{2}} \right|^{2} & \left| \frac{1 + x}{2 + y^{2}} \right|^{2} & \left\backslash \frac{1 + x}{2 + y^{2}} \right\backslash^{2} & \left/ \frac{1 + x}{2 + y^{2}} \right/^{2} & \left< \frac{1 + x}{2 + y^{2}} \right>^{2} &\ \left\lfloor \frac{1 + x}{2 + y^{2}} \right\rceil^{2} & \left\lceil \frac{1 + x}{2 + y^{2}} \right\rfloor^{2} & \left\ulcorner \frac{1 + x}{2 + y^{2}} \right\lrcorner^{2} & % not stretchy \left\llcorner \frac{1 + x}{2 + y^{2}} \right\urcorner^{2} & % not stretchy \left( \frac{1 + x}{2 + y^{2}} \right]^{2} & % mix and match \left\uparrow \frac{1 + x}{2 + y^{2}} \right\downarrow^{2} & % weird \left\Uparrow \frac{1 + x}{2 + y^{2}} \right\Downarrow^{2} & % weirder \left\updownarrow \frac{1 + x}{2 + y^{2}} \right\Updownarrow^{2} &\ % weirdest \left. \frac{1 + x}{2 + y^{2}} \right)^{2} & % no left delimiter \left( \frac{1 + x}{2 + y^{2}} \right.^{2} & % no right delimiter \left. \frac{1 + x}{2 + y^{2}} \right.^{2} % no delimiters at all \end{matrix} $$

You can also do inline formulas thusly: $$[(a * b) + (c * d)]^{2}$$


You include certain directives at the very top of your file, to affect the entire deck:

  • footer: footer: whatever you want your footer to be
  • numbered slides: slidenumbers: true
  • auto-fit all text onto slides: autoscale: true
  • show list bullets one by one: build-lists: true

I'm not going to demonstrate this one, because it'll make all the other examples too noisy.


See also the official cheatsheet