| 1 | # eloc
|
| 2 |
|
| 3 | [![npm version][npm-src]][npm-href]
|
| 4 | [![Install size][packagephobia-src]][packagephobia-href]
|
| 5 | [![License][license-src]][license-href]
|
| 6 |
|
| 7 | Eloquence cli. For presenters who (1) focus on writing, (2) present in a concise style.
|
| 8 |
|
| 9 | - Serve markdown as presentation
|
| 10 | - Static export
|
| 11 | - Live editor
|
| 12 | - Print view
|
| 13 | - Mobile view
|
| 14 | - Dark mode
|
| 15 | - Customization
|
| 16 |
|
| 17 | All of this in a 1MB cli. Checkout https://eloc.now.sh
|
| 18 |
|
| 19 | ### Presentation in Markdown ABC
|
| 20 |
|
| 21 | Break markdown into slides with `---` (horizontal rule), and that's all. e.g. `slides.md`:
|
| 22 |
|
| 23 | ```
|
| 24 | # Hello World
|
| 25 | ---
|
| 26 | Brown fox jumps over the lazy dog.
|
| 27 | ---
|
| 28 | ## Thanks
|
| 29 | ```
|
| 30 |
|
| 31 | then `eloc slides.md` gives you:
|
| 32 |
|
| 33 | <p align="center"><img src="https://eloc-screenshot.now.sh" height="420px" /></p>
|
| 34 |
|
| 35 | ## Usage
|
| 36 |
|
| 37 | ```
|
| 38 | eloc - Elequence cli
|
| 39 |
|
| 40 | Usage
|
| 41 |
|
| 42 | $ eloc <markdown-file> Serve markdown file as presentation
|
| 43 | $ eloc open <markdown-file> Open markdown file as presention in browser
|
| 44 | $ eloc build <markdown-file> Export presentation to directory
|
| 45 |
|
| 46 | Options
|
| 47 |
|
| 48 | -p, --port Port (default: 3000)
|
| 49 | -c, --css External css for customization
|
| 50 | -i, --include Files for referencing in markdown (format: glob)
|
| 51 | -o, --out-dir Output directory for build (default: public)
|
| 52 | -t, --title HTML title (default: <markdown-filename>)
|
| 53 | -q, --quiet Mute verbose logs
|
| 54 |
|
| 55 | -h, --help Display usage information
|
| 56 | -v, --version Display version number
|
| 57 |
|
| 58 | Examples
|
| 59 |
|
| 60 | # Serve "deck.md" as presentation
|
| 61 | $ eloc deck.md
|
| 62 |
|
| 63 | # Create & open "new-deck.md" as presentation in browser
|
| 64 | $ eloc new-deck.md
|
| 65 |
|
| 66 | # Export presentation with images
|
| 67 | $ eloc build deck.md --include "*.jpg"
|
| 68 | ```
|
| 69 |
|
| 70 | ### Customization
|
| 71 |
|
| 72 | - Use inline `<style />` tag in markdown for per-slide style:
|
| 73 |
|
| 74 | ```
|
| 75 | _write style tag within markdown_
|
| 76 |
|
| 77 | <style>
|
| 78 | .slide { background: url(...) }
|
| 79 | .content { filter: invert() }
|
| 80 | code { opacity: 0.8 }
|
| 81 | </style>
|
| 82 | ```
|
| 83 |
|
| 84 | ## See Also
|
| 85 |
|
| 86 | - [markdown-deck](https://github.com/amio/markdown-deck): a web component for presenters
|
| 87 |
|
| 88 | [npm-src]: https://badgen.net/npm/v/eloc
|
| 89 | [npm-href]: https://www.npmjs.com/package/eloc
|
| 90 | [coverage-src]: https://badgen.net/codecov/c/github/amio/eloc
|
| 91 | [coverage-href]: https://codecov.io/gh/amio/eloc
|
| 92 | [packagephobia-src]: https://badgen.net/packagephobia/install/eloc
|
| 93 | [packagephobia-href]: https://packagephobia.now.sh/result?p=eloc
|
| 94 | [license-src]: https://badgen.net/badge/license/MIT
|
| 95 | [license-href]: LICENSE.md
|
| 96 | |
| \ | No newline at end of file |