No description, website, or topics provided.
HTML Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
templates
.gitignore modificada el tipo de transición de revealjs Sep 1, 2016
Dockerfile
LICENSE
README.md cambios menores Feb 5, 2017
build.properties close #19 Feb 8, 2017
build.sh
gh-md-toc update README.md with Table Of Contents Feb 5, 2017
git-push.sh
to-slides.phatch

README.md

Markdown Slides

English

About

What is it?

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

The idea is that from a same MARKDOWN file we can get slides and books without worrying about style, just worrying about content.

Samples

From a MARKDOWN file generate:

Contributors

Licence

Instalation

Dependencies

Requirements

Now, only works in Linux (may be on MacOS)

It can works with Docker, but is in beta.

Download

https://github.com/asanzdiego/markdownslides/archive/master.zip

Docker

Your installation with docker is still under testing.

Any feedback is welcome.

Building docker image

It will be at dockerhub soon:

$ docker build -t asanzdiego/markdownslides .
Launch the container

Launch the container, product generated will be as min configuration

docker run -it -v ${PWD}/doc:/home/markdownslides/doc asanzdiego/markdownslides

Changing to med configuration

docker run -it -v ${PWD}/doc:/home/markdownslides/doc asanzdiego/markdownslides ./build.sh med doc

Changing to max configuation

docker run -it -v ${PWD}/doc:/home/markdownslides/doc asanzdiego/markdownslides ./build.sh max doc

How to use

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).

Notes

You can add notes that will be visible in book mode or if you press the letter 's' on the slides with @start-notes and @end-notes.

@start-notes
This is only visible in book mode or if you press 's' on the slides.
@end-notes

Levels

You can have as many levels as you want. Example:

# Level 1 (on slides and book)

## Level 2 (on slides and book)

### Level 3 (in book but stays level 2 in slides)

But only in books. In slides you can only have 2 levels.

Numbering

You can name several slides with (I), (II), etc. But only the first one will be exported to the book. Example:

## Foo Bar (I)

## Foo Bar (II)

In the book will be:

#### Foo Bar

Configuration

We can configure the files that we want to generate from the file build.properties

BUILD_REVEAL_SLIDES='min'
BUILD_REVEAL_SLIDES_PDF='med'
BUILD_REVEAL_SLIDES_ONLINE='med'
BUILD_REVEAL_SLIDES_ALTERNATIVE='max'
BUILD_REVEAL_SLIDES_ALTERNATIVE_PDF='max'
BUILD_REVEAL_SLIDES_ALTERNATIVE_ONLINE='max'

BUILD_HTML_BOOK='min'
BUILD_DOCX_BOOK='med'
BUILD_EPUB_BOOK='max'

Build

  • In the root folder you have to execute:
./build.sh [clean] [mode] [folder]
  • If you add [cleaN] the folder lib will be cleaned and the dependencies will be downloaded again.

  • [mode] can take the next values: min, med o máx.

  • [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.

Releases notes

Relese 1.0

  • Export slides to:
    • reveal-slides
    • reveal-slides-pdf
    • reveal-slides-alternative
    • reveal-slides-alternative-pdf
    • beamer-slides
    • deck-slides
    • deck-slides-alternative
  • Export books to:
    • html-book
    • docx-book
    • odt-book
    • pdf-book
  • Added generation modes 'min', 'med' and 'max'.
  • Automatic download the external libraries.
  • Numbering (I), (II), (III) ...

Relese 2.0

  • Export slides to:
    • reveal-slides
    • reveal-slides-pdf
    • reveal-slides-online
    • reveal-slides-alternative
    • reveal-slides-alternative-pdf
    • reveal-slides-alternative-online
  • Export books to:
    • html-book
    • docx-book
    • epub-book
  • Deprecated:
    • beamer-slides
    • deck-slides
    • deck-slides-alternative
    • odt-book
    • pdf-book
  • Added menu thanks to Raul Jimenez Ortega.
  • Added dockerfile thanks to Rubén Gómez García.
  • Clean zip files from libraries thanks to Cesar Seoane.
  • Added type 'online' thanks to Cesar Seoane.
  • Fixed bug HTTPS images thanks to Cesar Seoane.
  • Loading the online libraries with HTTPS thanks to Cesar Seoane.
  • Configuration PDF resolution thanks to Cesar Seoane.
  • New format 'epub'.
  • Added 'bash strict mode'.
  • Added 'build.properties' to configure file generation.
  • Added command 'clean' to clean the lib folder.
  • Download a specific version of external library.
  • Added notes only visible in book mode or if you press 's' on the slides.
  • Normalization of images in slides (witdh = 50% and align = center).

Español

Acerca de

¿Qué es esto?

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

La idea es que a partir de un mismo fichero MARKDOWN podamos obtener slides y libros sin preocuparnos por el estilo, solo por el contenido.

Ejemplos

A partir de un fichero MARKDOWN genera:

Colaboradores

Licencia

Instalación

Dependencias

Requisitos

Por ahora, solo funciona en Linux (y puede que en MacOS).

Puede funcionar con Docker, pero todavía está en pruebas.

Descarga

https://github.com/asanzdiego/markdownslides/archive/master.zip

Docker

Su instalación con docker está todavía en pruebas.

Cualquier feedback es bienvenido.

Construir la imagen

Estará en Dockerhub pronto:

$ docker build -t asanzdiego/markdownslides .
Lanzar el contenedor

Lanzamos el contenedor con la configuración min

docker run -it -v ${PWD}/doc:/home/markdownslides/doc asanzdiego/markdownslides

Cambiando a configuración med

docker run -it -v ${PWD}/doc:/home/markdownslides/doc asanzdiego/markdownslides ./build.sh med doc

Cambiando a configuración max

docker run -it -v ${PWD}/doc:/home/markdownslides/doc asanzdiego/markdownslides ./build.sh max doc

Manejo

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).

Notas

Puedes añadir notas que serán visibles en modo libro o si pulsas la letra 's' en las slides mediante @start-notes y @end-notes.

@start-notes
Esto solo es visible en modo libro o si pulsas 's' en las slides.
@end-notes 

Niveles

Puedes tener tantos niveles como quieras. Ejemplo:

### Nivel 1 (en slides y libro)

#### Nivel 2 (en slides y libro)

##### Nivel 3 (en libro pero se queda como nivel 2 en slides) 

Pero sólo en los libros. En las slides solo puedes tener 2 niveles.

Numeración

Puedes nombrar igual varias slides con (I), (II), etc. pero luego solo el primero será exportado al libro. Ejemplo:

#### Foo Bar (I)

#### Foo Bar (II)

En el libro quedará:

#### Foo Bar

Configuración

Podemos configurar los ficheros que queremos generar desde el fichero build.properties

BUILD_REVEAL_SLIDES='min'
BUILD_REVEAL_SLIDES_PDF='med'
BUILD_REVEAL_SLIDES_ONLINE='med'
BUILD_REVEAL_SLIDES_ALTERNATIVE='max'
BUILD_REVEAL_SLIDES_ALTERNATIVE_PDF='max'
BUILD_REVEAL_SLIDES_ALTERNATIVE_ONLINE='max'

BUILD_HTML_BOOK='min'
BUILD_DOCX_BOOK='med'
BUILD_EPUB_BOOK='max'

Generación

  • Hay que posicionarse en la carpeta raiz, y ejecutar:
./build.sh [clean] [modo] [carpeta]
  • Si añades [clean] se limpiará la carpeta lib y se volverán a bajar las dependencias.

  • [modo] puede tomar los siguientes valores: min, med o máx.

  • [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.

Releases notes

Relese 1.0

  • Exporta slides a:
    • reveal-slides
    • reveal-slides-pdf
    • reveal-slides-alternative
    • reveal-slides-alternative-pdf
    • beamer-slides
    • deck-slides
    • deck-slides-alternative
  • Exporta books a:
    • html-book
    • docx-book
    • odt-book
    • pdf-book
  • Añadidos los modos de generación 'min', 'med' y 'max'.
  • Descarga automática de librerías externas.
  • Numeración (I), (II), (III)...

Relese 2.0

  • Exporta slides a:
    • reveal-slides
    • reveal-slides-pdf
    • reveal-slides-online
    • reveal-slides-alternative
    • reveal-slides-alternative-pdf
    • reveal-slides-alternative-online
  • Exporta books a:
    • html-book
    • docx-book
    • epub-book
  • Deprecated:
    • beamer-slides
    • deck-slides
    • deck-slides-alternative
    • odt-book
    • pdf-book
  • Añadido menú gracias a Raul Jimenez Ortega.
  • Añadido dockerfile gracías a Rubén Gómez García.
  • Limpieza de ficheros zip de las librerías gracias a Cesar Seoane.
  • Añadido tipo 'online' gracias a Cesar Seoane.
  • Arreglado fallo imágenes HTTPS gracias a Cesar Seoane.
  • Carga de librerias 'online' por HTTPS gracias a Cesar Seoane.
  • Configuración resolución PDF gracias a Cesar Seoane.
  • Nuevo formato 'epub'.
  • Añadido 'bash strict mode'.
  • Añadido 'build.properties' para configurar la generación de ficheros.
  • Añadido comando 'clean' para limpiar la carpeta lib.
  • Descarga de una versión concreta de librería externa.
  • Añadidas notas solo visibles en modo libro o si pulsas 's' en las slides.
  • Normalización de imágenes en slides (witdh=50% y align=center).