markdown-to-slides-server

Parses a markdown file into HTML slides and starts a server with browser sync. Uses markdown-to-slides to parse your markdown into HTML. Every change to your markdown file will cause the slides in the browser to reload.

Table of Contents generated with DocToc

• Install
• Usage
• Methods
  • ({[<Number> port,] <String> markdown[, <Boolean> open,] [<String> title]})
• Tests
• Developing
  • Requirements
• License

Install

npm i -g markdown-to-slides-server

Usage

slides -f my-markdown.md
# see all the options
slides --help

Or, programmatic usage:

import markdownToSlidesServer from 'markdown-to-slides-server'

const quit = markdownToSlidesServer({port, markdown, open, title})

// later, when you want to kill the server
quit()

Methods

({[<Number> port,] <String> markdown[, <Boolean> open,] [<String> title]})

Starts the server. Returns a function that can be called to quit the server.

Tests

Tests are in tape.

• npm test will run the tests
• npm run tdd will run the tests on every file change.

Developing

To publish, run npm run release -- [{patch,minor,major}]

NOTE: you might need to sudo ln -s /usr/local/bin/node /usr/bin/node to ensure node is in your path for the git hooks to work

Requirements

• npm > 2.0.0 So that passing args to a npm script will work. npm i -g npm
• git > 1.8.3 So that git push --follow-tags will work. brew install git

License

Artistic 2.0 © Joey Baker and contributors. A copy of the license can be found in the file LICENSE.