Atom package for conversion of elearn.js Markdown to HTML and PDF
Branch: master
Clone or download
Latest commit 56de280 Dec 18, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update ISSUE_TEMPLATE Jun 4, 2018
images Update README.md Apr 19, 2018
keymaps refa/Command: renamed elearnjs-plugin to atom-elearnjs Apr 4, 2018
menus feat/ExportOptions: setting to not always display Apr 10, 2018
spec refa/comments: add class comments Nov 5, 2018
src fix/SaveLocations: do not read outdated format Dec 18, 2018
styles feat/OptionMenu: make it scrollable Nov 6, 2018
.eslintrc refa/async: use async functions Oct 24, 2018
.gitattributes refa/assets: removed assets (not used anymore) Jun 6, 2018
.gitignore Update CHANGELOG.md Apr 25, 2018
CHANGELOG.md fix/SaveLocations: do not read outdated format Dec 18, 2018
LICENSE.md Update LICENSE.md Mar 29, 2018
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Apr 11, 2018
README.md Update README.md, remove planned features Nov 12, 2018
package-lock.json
package.json Prepare 0.6.5 release Dec 18, 2018

README.md

Atom elearn.js

This package converts Markdown files to HTML and PDF and is specifically designed to use elearn.js for styling and interactive elements.

Create a simple elearn.js based script in no time!

atom-elearnjs Demo Video

Installation

Simply search for atom-elearnjs in Atom's Settings view to install this package.

Usage

In Atom open your Markdown file. Afterwards you can do any of the following:

  • use the Package tab, access elearn.js and convert to either html or pdf
  • Right-Click in the editor window and choose elearn.js - to HTML or elearn.js - to PDF
  • you can also use Save as... in the menus described above to select an output location
  • Convert with hotkeys:
    • To HTML: ctrl-alt-o
    • To PDF: ctrl-alt-p

All locations will be stored by their output type and the markdown file and will only be overwritten when Save as... (described above) is used.

Markdown syntax is supported based on Showdown's features. If you want to use specific elearn.js features check the extended documentation.

Extended Documentation

Check our wiki pages for examples and detailed documentation.

There are also useful hints for beginners or troubleshooting.

Known Issues

  • All platforms:
    • PDF output might be slow
      • consider keeping Chrome alive after the first export (check settings)

Credits

  • Atom the editor you need!
  • elearn.js based for output scripts and styles.
  • Showdown used for Markdown to HTML conversion.
  • Puppeteer used for HTML to PDF conversion.

License

atom-elearnjs is developed by dl.min of Universität Hamburg.

The software is using MIT-License.

cc-by Michael Heinecke, Arne Westphal, dl.min, Universität Hamburg