Git Product home page Git Product logo

marp's Introduction

Marp

Markdown presentation writer, powered by Electron.

Marp

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.

Licenses

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

marp's People

Contributors

yhatt avatar will-hart avatar btbytes avatar radarhere avatar abunsen avatar koic avatar jackycute avatar valentinsteinwandter avatar vittorioromeo avatar alexander-shvets avatar brandly avatar

Watchers

Shyamal Suhana Chandra avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.