Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amio/eloc
A CLI for presentations in markdown
https://github.com/amio/eloc
cli markdown nodejs npm presentation slides
Last synced: 3 days ago
JSON representation
A CLI for presentations in markdown
- Host: GitHub
- URL: https://github.com/amio/eloc
- Owner: amio
- License: mit
- Created: 2019-09-25T16:20:14.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T21:56:03.000Z (4 months ago)
- Last Synced: 2024-10-15T01:23:49.598Z (21 days ago)
- Topics: cli, markdown, nodejs, npm, presentation, slides
- Language: TypeScript
- Homepage: https://eloc.now.sh
- Size: 1.29 MB
- Stars: 60
- Watchers: 4
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# eloc
[![npm version][npm-src]][npm-href]
[![Install size][packagephobia-src]][packagephobia-href]
[![License][license-src]][license-href]
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][packagephobia-href] 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
```bash
npm install -g eloc
```
## Usage
```
eloc - The eloquent cli
Usage
$ eloc Serve markdown file as presentation
$ eloc open Open markdown file as presention in browser
$ eloc build Export presentation to directory
Options
-p, --port Port (default: 5000)
-c, --css External css for customization
-i, --include Files for referencing in markdown
-o, --out-dir Output directory for build (default: public)
-t, --title HTML title (default: )
-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 `` for [per-slide customization](https://eloc.now.sh/#6):
```
_write style tag within markdown_
.slide { background: url(...) }
.content { filter: invert() }
code { opacity: 0.8 }
```
- https://math.vercel.app/ is your friend for embedding math equations.
## See Also
- [markdown-deck](https://github.com/amio/markdown-deck): a web component for presenters
## Prior Art
- [mdx-deck](https://github.com/jxnblk/mdx-deck) - If you want to enhance slides with React, this is the one.
- [slides.com](https://slides.com) - Beautiful and powerful, the final choice for full featured presentation.
- [big](https://github.com/tmcw/big) - The boldest style, for fan of [Takahashi method](https://en.wikipedia.org/wiki/Takahashi_method).
[npm-src]: https://badgen.net/npm/v/eloc
[npm-href]: https://www.npmjs.com/package/eloc
[coverage-src]: https://badgen.net/codecov/c/github/amio/eloc
[coverage-href]: https://codecov.io/gh/amio/eloc
[packagephobia-src]: https://badgen.net/packagephobia/install/eloc
[packagephobia-href]: https://packagephobia.now.sh/result?p=eloc
[license-src]: https://badgen.net/badge/license/MIT
[license-href]: LICENSE.md