Skip to content

Latest commit

 

History

History
169 lines (109 loc) · 2.72 KB

example.md

File metadata and controls

169 lines (109 loc) · 2.72 KB

Marp

Markdown presentation writer, powered by Electron
Created by Yuki Hattori ( @yhatt )

Features

  • Slides can write by Markdown.
  • Cross-platform. Supported Windows, Mac, and Linux
  • Live Preview with 3 modes
  • Slide themes (default, gaia)
  • Supports emoji ❤️
  • Export your slides to PDF

How to write slides?

Split slides by horizontal ruler ---. It's very simple.

# Slide 1

foobar

---

# Slide 2

foobar

Notice: Ruler (<hr>) is not display in Marp.


Directives

Marp's Markdown has extended directives to affect slides.

Insert HTML comment as below:

<!-- {directive_name}: {value} -->
<!--
{first_directive_name}:  {value}
{second_directive_name}: {value}
...
-->

Page Directive

The page directive would apply to current page and later. You should insert it to top when apply to all slides.

page_number

Set true to show page number on slides. See lower right!

<!-- page_number: true -->

template

Set to use template of theme.

The template directive just enables that using theme supports templates.

<!--
$theme: gaia
template: invert
-->

Example: Set "invert" template of Gaia theme.

Global Directive

$theme

Change slide theme. You can also change from View -> Theme menu.

<!-- $theme: gaia -->
Theme name Value Directive
Default default <!-- $theme: default -->
Gaia gaia <!-- $theme: gaia -->

$width / $height

Change slide width and height. You can use units: px (default), cm, mm, in, pt, and pc.

<!-- $width: 12in -->

$size

Change slide size by presets. Presets: 4:3, 16:9, A0-A8, B0-B8 and suffix of -portrait.

<!-- $size: 16:9 -->

Pro Tips

Page Directive can apply temporally to only current slide. Try to add * to top of Page Directive name!

<!-- *page_number: false -->
<!-- *template: invert -->

Enjoy writing slides! 👍

Copyright © 2016 Yuki Hattori This software released under the MIT License.