Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including eloc with all npm packages installed. Try it out:

eloc lists no main file and has no index.js, so it can't be directly required. If this is a mistake, please let us know. It may however contain internal files that you can require manually:

// require("eloc/[??]")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

eloc v1.3.0

1MB cli for markdown presentation authoring

eloc

npm version Install size License

Eloquence cli. For presenters who (1) focus on writing, (2) present in a concise style.

  • Serve markdown as presentation
  • Live editor
  • Static export
  • Print view / Mobile view / Dark mode
  • Customizable with web standard

All of this in a 1MB cli. Check out https://eloc.now.sh

Presentation in Markdown ABC

Break markdown into slides with --- (horizontal rule), and that's all. e.g. slides.md:

# Hello World
---
Brown fox jumps over the lazy dog.
---
## Thanks

then eloc slides.md gives you:

Install

npm install -g eloc

Usage

  eloc - Eloquence cli

  Usage

    $ eloc <markdown-file>        Serve markdown file as presentation
    $ eloc open <markdown-file>   Open markdown file as presention in browser
    $ eloc build <markdown-file>  Export presentation to directory

  Options

    -p, --port <number>     Port (default: 3000)
    -c, --css <file>        External css for customization
    -i, --include <globs>   Files for referencing in markdown
    -o, --out-dir <dir>     Output directory for build (default: public)
    -t, --title <string>    HTML title (default: <markdown-filename>)
    -b, --progress-bar      Enable progress bar

    -q, --quiet             Mute verbose logs
    -v, --version           Display version number
    -h, --help              Display usage information

  Examples

    # Serve "deck.md" as presentation
    $ eloc deck.md

    # Create & open "new-deck.md" as presentation in browser
    $ eloc open new-deck.md

    # Export presentation with images
    $ eloc build deck.md --include "*.jpg"

Customization & Tips

  • Use --css arg with an external stylesheet, which will be applied on every slide.

  • Use inline <style /> for per-slide customization:

    _write style tag within markdown_
    
    <style>
      .slide { background: url(...) }
      .content { filter: invert() }
      code { opacity: 0.8 }
    </style>
    
  • https://math.now.sh/ is your friend for embedding math equations.

Deploy to now

in 1 minute.

Assume you alread had an index.md wrote with eloc open index.md, then:

echo '{"scripts":"build":"eloc build index.md"}}' > package.json
echo '.now\nnode_modules' > .gitignore
npm i -D eloc
now -c --prod

See Also

Prior Art

  • mdx-deck - If you want to enhance slides with React, this is the one.
  • slides.com - Beautiful and powerful, the final choice for full featured presentation.

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free