Marp

Markdown presentation writer, powered by Electron.

Usage

Install

▶️ Download latest archives from release page.

Windows: Unzip *.*.*-Marp-win32-[arch].zip and run Marp.exe.
Mac OS X: Mount *.*.*-Marp-darwin-x64.dmg, D&D Marp to Applications and run it from Applications folder / Launchpad. Or use Homebrew Cask: brew cask install marp
Linux: Unpack *.*.*-Marp-linux-[arch].tar.gz and run Marp.

How to write slides?

Split slides by horizontal ruler ---. It's very simple. Please refer to example.md.

# Slide 1

foobar

---

# Slide 2

foobar

For developers

Getting started

npm install
npm start

Customizing Slide CSS

It's easy, include a <link> tag at the top of your presentation, or alternatively a <style> tag that contains all of your styles. All CSS should be targeting either .slide or elements inside of .slide. For reference, check out the gaia theme in the sass folder.

Create release builds

gulp release

Please set application version in package.json.

OS specific

Windows

If you want to build for Windows in other platforms, please install Wine to rewrite Electron's resources.

OSX

To build for Darwin is only supported in OSX. Please install appdmg to create archive (.dmg) for Darwin release.

npm install appdmg

Notices

Don't add development dependency of appdmg to package.json. The release task would fail in other platforms.
gulp-appdmg is no longer in use since v0.0.4.

braitom/marp