Home

Awesome

<!--markpress-opt { "theme": "light", "autoSplit": false, "sanitize": false, "noEmbed": false, "edit": true, "title": "README" } markpress-opt--> <!--slide-attr x=0 y=0 -->

Markpress

Markpress npm badge Build Status node GitHub stars GitHub followers

markpress is a command line tool and node package to convert markdown files into self-contained impressjs html presentations. It was initially inspired and based on markdown-impress by steel1990.

This is the outcome of feeding this very README.md to markpress: $ markpress README.md

<!--slide-attr x=2600 y=0 -->

How to install

You'll need node version >= 5.0.0 installed on your system.

$ npm install -g markpress (globally)

or

$ npm install markpress (for the current folder only)

<!--slide-attr x=2600 y=2600 -->

Features

<!--slide-attr x=0 y=2600 rotate=90 -->

Usage

CLI

$ markpress <input file> [output file] [options]

If no output file is passed, the input's filename will be used with .html extension.

More information: $ markpress -h

In your code

See Examples section for more.

const fs = require('fs');
const markpress = require('markpress');
const options = { ... };
markpress('input.md', options).then(({html, md}) => {
  fs.writeFileSync('output.html', html);
});

// or you can pass the Markdown content directly as parameter
markpress('# Markdown content \n > Blockquote', options).then(({html, md}) => {
  fs.writeFileSync('output.html', html);
});
<!--slide-attr x=-2600 y=1300 rotate-x=90 rotate-y=45 -->

Markdown format, Custom Layout and Styles

<!--slide-attr x=0 y=4000 z=0 rotate-y=0 -->

Options

The options precedence is as follows (higher in the least means higher precedence):

-a, --auto-split or { autoSplit: Boolean } in code

Default: false

Automatically create a slide for every H1 (# Heading 1) level element (if ------ are present will be removed and ignored)

<!--slide-attr x=0 y=4000 z=1200 rotate-y=45 -->

-l, --layout or { layout: String } in code

Default: horizontal

Automatically generate the layout for the slides. This option will be ignored if any HTML comment specifying slide positioning attributes is found, so please remove all slide-positioning comments (<!--slide-attr ... -->) from the markdown file if you want to use this feature. Available Layouts:

<!--slide-attr x=1200 y=4000 z=1800 rotate-y=90 -->

-E, --no-embed or { embed: false } in code

Default: true (pass --no-embed through CLI to disable)

By default, markpress will try to embed (using base64 encoding) the referenced images into the HTML so they will be available offline and you will not have problems moving the HTML to other folders. This feature will be disabled if --no-embed is set to true.

-z, --sanitize or { sanitize: boolean } in code

Default: false (dangerous HTML & scripts allowed)

Disallow embedding of dangerous HTML code in the Markdown file. You should leave it disabled if you want to use custom <style> tags, embed videos, etc.

--silent or { verbose: Boolean } in code

--silent Will silence all console output in the Terminal. {verbose: true} will enable all console output.

Default (CLI): silence: false (all console output enabled by default)

Default (module): verbose: false (all console output disabled by default)

<!--slide-attr x=2400 y=4000 z=2400 rotate-y=135 -->

-t <theme>, --theme <theme> or { theme: String } in code

Default: light

Chose from the different available themes:

-s, --save or { save: Boolean } in code

Default: false

Embed the markpress options into the .md file for portability. Warning: it will override any existing options.

-e, --edit only available in CLI

Start edit mode. This will start an embedded web server to preview the resulting HTML with live refresh upon input file change. Press ctrl+c to stop the server.

<!--slide-attr x=1000 y=1000 scale=0.5 -->

Developing

Run

$ node --harmony ./bin/markpress.js input.md

Debug

$ node debug --harmony ./bin/markpress.js input.md

Linking

npm link

Installing local version globally

npm install . -g

<!--slide-attr x=2000 y=1000 scale=0.5 -->

API

markpress(input, options)

input

An String with either:

options

An Object containing the options as specified in the Options section

returns

A Promise which will call it's resolve method with an Object with two properties:

Note that you can use ES6 destructuring to simulate Python's named parameters in JS.

<!--slide-attr x=1000 y=2000 z=1000 -->

Examples

const fs = require('fs');
const markpress = require('markpress');
const options = {
  layout: 'horizontal',
  theme: 'light',
  autoSplit: true,
  allowHtml: false,
  verbose: false,
  title: 'Optional <title> for output HTML'
}
// Simulating named parameters through destructuring
markpress('input.md', options).then(({html, md}) => {
  fs.writeFileSync('output.html', html);
  // if `md` is defined it contains the markdown content with embedded options (see --save option)
});

// or you can pass the Markdown content directly as parameter

markpress(
  '# This is markdown content \n > Test Blockquote',
  options
).then(({html, md}) => {
  fs.writeFileSync('output.html', html);
});
<!--slide-attr x=1000 y=1500 z=500 rotate-x=90 scale=0.5 -->

Roadmap

Roadmap of planned features can be found here. Suggestions are welcome.

Contributing

Please see CONTRIBUTING.md

References and tools used

<!-- zoom-out slide --> <!--slide-attr x=1200 y=2000 z=4000 scale=2 -->

Thanks for reading until the end :grin: