Skip to content

tripu/remarker

 
 

Repository files navigation

remarker v1.2.1

CircleCI codecov

Remark cli

remark is a simple, in-browser, markdown-driven slideshow tool. remarker is a command line tool for building a remark-based slideshow page very easily.

Usage

Install via npm:

$ npm install --save remarker

Write your slide in markdown:

# My Slide

---

# My Slide 2

???

Presenter notes here

---

save the above as slides.md

Invoke remarker command.

$ ./node_modules/.bin/remarker

This starts a local server at port 6275 (this is configurable) and you can see your slides at http:https://localhost:6275/.

See remark's slide and documentation for more details about its syntax, features etc.

Build slides

You can build your slides as static page as remarker build command.

$ ./node_modules/.bin/remarker build

This builds your slides as html page under build/ directory. The output directory is configurable. See the below for details.

Installing globally

You can instead install it globally, in one of these two ways:

sudo npm i -g remarker    # from the npm repository
sudo npm i -g .           # if there's a clone in the current directory

After that, you should be able to invoke it this way from any directory in your system:

remarker [build]

Configuration

You can configure remarker with configuration file called remarker.yml:

Default settings are as follows:

port: 6275
dest: build
source: slides.md
assets: ['assets']
title: ''
css: ''
  • port is the port number of remarker server. Default is 6275.
  • dest is the destination of remarker build command. Default is build
  • source is the source markdown filename. Default is slides.md.
  • assets is the list of assets directory. These directories are copied/served statically.
  • title is the page title of the slides. Default is an empty string.
  • css is css text you want to add to slides' html page.

Examples

License

MIT

Packages

 
 
 

Languages

  • JavaScript 85.2%
  • Nunjucks 14.8%