eloc
1MB cli for markdown presentation authoring
Last updated a month ago by amio .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install eloc 
SYNC missed versions from official npm registry.

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.

Current Tags

  • 1.3.0                                ...           latest (a month ago)

32 Versions

  • 1.3.0                                ...           a month ago
  • 1.2.5                                ...           a month ago
  • 1.2.4                                ...           2 months ago
  • 1.2.3                                ...           2 months ago
  • 1.2.2                                ...           3 months ago
  • 1.2.1                                ...           3 months ago
  • 1.2.0                                ...           4 months ago
  • 1.1.19                                ...           5 months ago
  • 1.1.18                                ...           6 months ago
  • 1.1.17                                ...           7 months ago
  • 1.1.16                                ...           7 months ago
  • 1.1.15                                ...           7 months ago
  • 1.1.14                                ...           7 months ago
  • 1.1.13                                ...           7 months ago
  • 1.1.12                                ...           7 months ago
  • 1.1.11                                ...           7 months ago
  • 1.1.10                                ...           7 months ago
  • 1.1.9                                ...           7 months ago
  • 1.1.8                                ...           7 months ago
  • 1.1.5                                ...           8 months ago
  • 1.1.4                                ...           8 months ago
  • 1.1.3                                ...           8 months ago
  • 1.1.2                                ...           8 months ago
  • 1.1.1                                ...           8 months ago
  • 1.1.0                                ...           8 months ago
  • 1.0.2                                ...           8 months ago
  • 1.0.1                                ...           8 months ago
  • 1.0.0                                ...           8 months ago
  • 0.0.3                                ...           8 months ago
  • 0.0.2                                ...           8 months ago
  • 0.0.1                                ...           8 months ago
  • 0.0.0                                ...           8 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 50
Dependencies (0)
None
Dev Dependencies (18)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |