{"id":16975771,"url":"https://github.com/amio/eloc","last_synced_at":"2025-04-12T18:55:33.914Z","repository":{"id":35149885,"uuid":"210889639","full_name":"amio/eloc","owner":"amio","description":"A CLI for presentations in markdown","archived":false,"fork":false,"pushed_at":"2024-07-18T21:56:03.000Z","size":1351,"stargazers_count":60,"open_issues_count":13,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-15T01:23:49.598Z","etag":null,"topics":["cli","markdown","nodejs","npm","presentation","slides"],"latest_commit_sha":null,"homepage":"https://eloc.now.sh","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/amio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-25T16:20:14.000Z","updated_at":"2024-08-04T13:51:58.000Z","dependencies_parsed_at":"2024-04-19T22:38:25.915Z","dependency_job_id":"32319240-46fc-4a55-8e8f-df04a29523bf","html_url":"https://github.com/amio/eloc","commit_stats":{"total_commits":144,"total_committers":4,"mean_commits":36.0,"dds":"0.24305555555555558","last_synced_commit":"0e0de2b2221d79da62ab134027d75f4bf9d223ff"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amio%2Feloc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amio%2Feloc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amio%2Feloc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/amio%2Feloc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/amio","download_url":"https://codeload.github.com/amio/eloc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618273,"owners_count":21134200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","markdown","nodejs","npm","presentation","slides"],"created_at":"2024-10-14T01:23:53.409Z","updated_at":"2025-04-12T18:55:33.908Z","avatar_url":"https://github.com/amio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# eloc\n\n[![npm version][npm-src]][npm-href]\n[![Install size][packagephobia-src]][packagephobia-href]\n[![License][license-src]][license-href]\n\nEloquence cli. For presenters who (1) focus on writing, (2) present in a concise style.\n\n- Serve markdown as presentation\n- Live editor\n- Export to html\n- Print view / Mobile view / Dark mode\n- Customizable with web standard\n\nAll of this in a [1MB][packagephobia-href] cli. Check out https://eloc.vercel.app\n\n### Presentation in Markdown ABC\n\nBreak markdown into slides with `---` (horizontal rule) like this in `slides.md`:\n\n```\n# Hello World\n---\nBrown fox jumps over the lazy dog.\n---\n## Thanks\n```\n\nthen `eloc slides.md` gives you the presentation with live editor:\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://eloc-screenshot.now.sh\" width=\"100%\" /\u003e\u003c/p\u003e\n\n## Install\n\n```bash\nnpm install -g eloc\n```\n\n## Usage\n\n```\n  eloc - The eloquent cli\n\n  Usage\n\n    $ eloc \u003cmarkdown-file\u003e        Serve markdown file as presentation\n    $ eloc open \u003cmarkdown-file\u003e   Open markdown file as presention in browser\n    $ eloc build \u003cmarkdown-file\u003e  Export presentation to directory\n\n  Options\n\n    -p, --port \u003cnumber\u003e     Port (default: 5000)\n    -c, --css \u003cfile\u003e        External css for customization\n    -i, --include \u003cglobs\u003e   Files for referencing in markdown\n    -o, --out-dir \u003cdir\u003e     Output directory for build (default: public)\n    -t, --title \u003cstring\u003e    HTML title (default: \u003cmarkdown-filename\u003e)\n    -b, --progress-bar      Enable progress bar\n    -d, --dark              Enable dark theme\n\n    -q, --quiet             Mute verbose logs\n    -v, --version           Display version number\n    -h, --help              Display usage information\n\n  Examples\n\n    # Serve \"deck.md\" as presentation\n    $ eloc deck.md\n\n    # Create \u0026 open \"new-deck.md\" as presentation in browser\n    $ eloc open new-deck.md\n\n    # Export presentation with images\n    $ eloc build deck.md --include \"*.jpg\"\n```\n\n### Customization \u0026 Tips\n\n- Use `--css` arg with an external stylesheet, which will be applied on every slide.\n\n- Use inline `\u003cstyle /\u003e` for [per-slide customization](https://eloc.now.sh/#6):\n\n  ```\n  _write style tag within markdown_\n\n  \u003cstyle\u003e\n    .slide { background: url(...) }\n    .content { filter: invert() }\n    code { opacity: 0.8 }\n  \u003c/style\u003e\n  ```\n\n- https://math.vercel.app/ is your friend for embedding math equations.\n\n## See Also\n\n- [markdown-deck](https://github.com/amio/markdown-deck): a web component for presenters\n\n## Prior Art\n\n- [mdx-deck](https://github.com/jxnblk/mdx-deck) - If you want to enhance slides with React, this is the one.\n- [slides.com](https://slides.com) - Beautiful and powerful, the final choice for full featured presentation.\n- [big](https://github.com/tmcw/big) - The boldest style, for fan of [Takahashi method](https://en.wikipedia.org/wiki/Takahashi_method).\n\n[npm-src]: https://badgen.net/npm/v/eloc\n[npm-href]: https://www.npmjs.com/package/eloc\n[coverage-src]: https://badgen.net/codecov/c/github/amio/eloc\n[coverage-href]: https://codecov.io/gh/amio/eloc\n[packagephobia-src]: https://badgen.net/packagephobia/install/eloc\n[packagephobia-href]: https://packagephobia.now.sh/result?p=eloc\n[license-src]: https://badgen.net/badge/license/MIT\n[license-href]: LICENSE.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famio%2Feloc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famio%2Feloc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famio%2Feloc/lists"}