Skip to content

strogo/md2slides

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

md2slides

Transform markdown files to your favourite presentation tool.

At the moment the only supported format is reveal.js but soon there will be more available.

Install

If you are not a Go dev, the easiest way is to get the latest release from the releases tab.

Write your slides

How should I write slides? It's just markdown adding a --- to change from slide to slide. Here is a small example:

md2slides
=========

---

This is an awesome tool!

Quick start

md2slides -d examples/reveal/main.md

Usage

$ md2slides -h
usage: md2slides [<flags>] <source>

Flags:
  -h, --help                Show context-sensitive help (also try --help-long and --help-man).
  -o, --output=/dev/stdout  output file where to write the HTML.
  -d, --daemon              start a simple HTTP serving your slides.
      --port=8080           port where to run the server.
  -c, --theme-config=THEME-CONFIG
                            configuration for the theme (JS file)
      --theme="reveal"      Choose one: [reveal, shower].

Args:
  <source>  Markdown source file.

Development

Dependencies

We use glide for this:

glide install

Build

There are some templates that should be added to the binary file, for doing that you will need go-bindata and run the following:

go generate

After that you are ready to build:

go build

TODO

  • Allow better configurations. For example, there is no way to change themes for reveal/shower ATM.
  • Tests ¯_(ツ)_/¯

About

Transform markdown files to your favourite presentation tool.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 95.9%
  • Shell 4.1%