/markdownslides

Primary LanguageJavaScriptGNU General Public License v2.0GPL-2.0

Markdown Slides

English

What is it?

  • MarkdownSlides is a Reveal.js, Deck.js and PDF slides generator from MARKDOWN files, that also generate HTML, ODT and DOCX documents.

Samples

Dependencies

  • Pandoc (needs to be installed)
  • Phantom.js (needs to be installed)
  • Reveal.js (downloaded automaticaly)
  • Deck.js (automaticaly downloaded)
  • Now, only works in Linux (may be on MacOS)

Download

Creation

  • First copy the doc folder and rename it as you like. This is not necessary but helps you organize your documents.

  • Create the md files that you want to generate in the md folder. The md files are Markdown files which are nothing more than plain text files with extension md, and a lightweight markup (we should know it but it is very simple).

  • Once created the md files, we can generate with an script.

    • reveal-slides
    • reveal-pdf-slides
    • deck-slides
    • pdf-beamer
    • pdf
    • html
    • docx
    • odt

Build

  • In the root folder you have to execute:
./build.sh [mode] [folder]

  • Where [mode] can take the next values:

    • "min": generate deck-slides and plain html.
    • "med": generate also reveal-slides, docx and odt (default value)
    • "max": generate all formats.

  • And where [folder] is the name of the folder wher to find the md files. If no folder name, it will convert all md files of all the folders.

Licence

Español

¿Qué es esto?

  • MarkdownSlides es un generador de slides Reveal.js, Deck.js y PDF a partir de ficheros MARKDOWN, que también genera documentos HTML, ODT y DOCX.

Ejemplos

Dependencias

  • Pandoc (necesita ser instalado)
  • Phantom.js (necesita ser instalado)
  • Reveal.js (descargado automaticamente)
  • Deck.js (bajado automáticamente)
  • Por ahora, solo funciona en Linux (y puede que en MacOS)

Descarga

Creación

  • Primero copia la carpeta doc y renombrala a tu gusto. Esto no es necesario pero te ayuda a organizar tus documentos.

  • Crea los ficheros md que quieras generar en la carpeta md. Los ficheros md son ficheros Markdown, que no son nada más que ficheros de texto plano, con extensión md, y con un marcado ligero (que hay que conocer pero que es muy sencillo).

  • Una vez creado los md, podemos generar con un script:

    • reveal-slides
    • reveal-pdf-slides
    • deck-slides
    • pdf-beamer
    • pdf
    • html
    • docx
    • odt

Generación

  • Hay que posicionarse en la carpeta raiz, y ejecutar:
./build.sh [modo] [carpeta]

  • Donde [modo] puede tomar los siguientes valores:

    • "min": genera deck-slides y html plano.
    • "med": genera ademas reveal-slides, docx y odt (valor por defecto)
    • "max": genera todos los formatos.

  • Y donde [carpeta] es la carpeta donde va a buscar los ficheros md. Si no se indica nada convertirá todos los ficheros md de todas las carpetas.

Licencia