Skip to content
Markdown presentation writer, powered by Electron.
Branch: master
Clone or download
Pull request Compare This branch is 53 commits ahead of yhatt:master.
Latest commit b1a7f02 Jul 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
coffee packt_themes Jun 16, 2019
css x Jul 8, 2019
docs Update release page to emphasize Marp Next Feb 17, 2019
examples Fix Gaia theme example's relative image path Jul 22, 2016
images Merge pull request yhatt#99 from yhatt/fix-twemoji-skintone Oct 8, 2016
resources Bundle KaTeX CSS files Jul 22, 2016
sass Bring up to speed with master May 2, 2019
.gitignore Move Github Pages from gh-pages to master Oct 2, 2016
.node-version Use the latest LTS node 8.10.0 Mar 27, 2018
LICENSE Update copyright years Mar 27, 2018
README.md Update README.md Feb 17, 2019
example.md Fix typo in example slides Feb 27, 2017
gulpfile.coffee Bring up to speed with master May 2, 2019
gulpfile.js Refactor code Feb 6, 2016
index.html add presentation mode (hasty) Sep 10, 2017
main.js Implement settings for compiling and running by gulp Feb 5, 2016
note.html Cleanup, support markdown in notes, add font size note buttons Oct 21, 2017
package-lock.json x Jan 24, 2019
package.json Bring up to speed with master May 2, 2019
screenshot.png Update screenshot.png May 29, 2016
slide.html Bring up to speed with master May 2, 2019
yarn.lock x Jul 19, 2019

README.md

Marp

Markdown presentation writer, powered by Electron.


⚠️ This repository is pre-release version, and we have already dropped maintenance. We are planning the future of Marp at @marp-team/marp.

See more details in yhatt/marp#267.

We will archive this repository when a future Marp has grown to replace a pre-release version.


Marp

Usage

Install

▶️ Download latest archives from release page.

  • Windows: Unzip *.*.*-Marp-win32-[arch].zip and run Marp.exe.
  • macOS: 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

yarn install
yarn 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

yarn 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.

macOS

To build for Darwin is only supported in macOS.

Licenses

Copyright © 2016-2018 Yuki Hattori.

This software released under the MIT License.

You can’t perform that action at this time.