Skip to content

Latest commit

 

History

History
111 lines (78 loc) · 3.14 KB

README.md

File metadata and controls

111 lines (78 loc) · 3.14 KB
Raw

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 - The eloquent 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: 5000)
    -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
    -d, --dark              Enable dark theme

    -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.vercel.app/ is your friend for embedding math equations.

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.
  • big - The boldest style, for fan of Takahashi method.