@asanzdiego
MarkdownSlides is a Reveal.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.
Now, only works in Linux (may be on MacOS)
It can works with Docker, but is in beta.
https://github.com/asanzdiego/markdownslides/releases
Your installation with docker is still under testing.
Any feedback is welcome.
$ docker build -t asanzdiego/markdownslides .
docker run -it -v "${PWD}":/home/markdownslides-master/"${PWD##*/}" \
asanzdiego/markdownslides ./build.sh [clean] [mode] [folder]
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).
Firt example:
@import import/import-2.md
Second example:
@import import/import-1.md endLine=4
Third example:
@import import/import-1.md startLine=6
- Line 1 of import-2.md
- Line 2 of import-2.md
- Line 3 of import-2.md
- Line 4 of import-2.md
Fourth example:
@import import/import-1.md startLine=2 endLine=3 showNumberLines
2 - Line 2 of import-1.md
3 - Line 3 of import-1.md
@start-notes
This is only visible in book mode or if you press 's' on the slides.
@end-notes
@plus the lines below will only be available in the plus version
@plus @import import/import-2.md
So this:
$$x = {-b \pm \sqrt{b^2-4ac}}.$$
Will be converted to:
\[x = {-b \pm \sqrt{b^2-4ac}}.\]
# 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.
## Foo Bar
## Foo Bar (II)
In the book will be:
## Foo Bar
We can configure the files that we want to generate from the file build.properties
DEFAULT_GENERATION_MODE='min'
GENERATE_PLUS_VERSION='yes'
DEFAULT_BUILD='REVEAL_SLIDES_PDF'
BUILD_REVEAL_SLIDES='min'
BUILD_REVEAL_SLIDES_PDF='med'
BUILD_HTML_BOOK='min'
BUILD_PDF_BOOK='med'
BUILD_DOCX_BOOK='max'
BUILD_EPUB_BOOK='max'
We can also configure some other stufs from the file build.properties
CLEAN_LIB_FOLDER='no'
COPY_IMG_FOLDER='no'
ZIP_EXPORT_FOLDER='no'
NUMBER_SECTIONS='no'
NUMBER_OFFSET='no'
CURRENT_NUMBER_OFFSET=1
REMOVE_GENERATE_MD_FILES='yes'
We can also configure some other stufs aboout reveal.js from the file build.properties
#THEME='black|white|league|sky|beige|simple|serif|blood|night|moon|solarized'
REVEAL_JS_THEME='beige'
REVEAL_JS_SHOW_TITLE_FOOTER='yes'
REVEAL_JS_DEFAULT_TITLE_FOOTER='yes'
REVEAL_JS_TITLE_FOOTER="'MarkdownSlides by @asanzdiego :-)'"
REVEAL_JS_SHOW_MENU='yes'
REVEAL_JS_SHOW_CHALKBOARD='yes'
REVEAL_JS_ONLINE='no'
[mode] can take the next values: min, med o máx.
[folder] folder wher to find the md files. If no folder name, it will convert all md files of all the folders.
Export slides to:
Export books to:
Deprecated:
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 the 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.
Old JEE web developer.
Now I’m Tecnical Teacher Advaisor in the TIC service of the General Direction of Infrastructure and Services of the Ministry of Education and Youth of the Community of Madrid.
In addition I work as trainer specialized in development technologies.
Hackathon Lovers: a group created for entrepreneurs and developers who loves hackathons.
Password Manager Generator: an online password manager.
MarkdownSlides: a script to create slides from MD files.